C4ScenarioListLoader::Scenario Class Reference

#include <C4StartupScenSelDlg.h>

Inheritance diagram for C4ScenarioListLoader::Scenario:

Collaboration diagram for C4ScenarioListLoader::Scenario:

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, bool &CanHide) override
bool	IsGrayed () override
bool	IsHidden () override
bool	HasMissionAccess () const override
StdStrBuf	GetOpenText () override
StdStrBuf	GetOpenTooltip () override
const C4Scenario &	GetC4S () const
bool	GetAchievement (int32_t idx, C4Facet *out_facet, const char **out_description) override
StdStrBuf	GetTypeName () override
const char *	GetDefaultExtension () override
C4ScenarioParameterDefs *	GetParameterDefs () override
C4ScenarioParameters *	GetParameters () override
bool	IsScenario () override
bool	Load (C4Group *pFromGrp, const StdStrBuf *psFilename, bool fLoadEx)
virtual Folder *	GetIsFolder ()
const StdStrBuf &	GetName () const
const StdStrBuf &	GetEntryFilename () const
const StdStrBuf &	GetVersion () const
const StdStrBuf &	GetAuthor () const
const C4Facet &	GetIconFacet () const
const C4Facet &	GetTitlePicture () const
const StdStrBuf &	GetDesc () const
int	GetIconIndex ()
int	GetDifficulty ()
int	GetFolderIndex ()
Entry *	GetNext () const
class Folder *	GetParent () const
virtual bool	HasUnregisteredAccess () const
virtual bool	SetTitleInGroup (C4Group &rGrp, const char *szNewTitle)
bool	RenameTo (const char *szNewName)

Static Public Member Functions
static Entry *	CreateEntryForFile (const StdStrBuf &sFilename, C4ScenarioListLoader *pLoader, Folder *pParent)

Protected Attributes
class C4ScenarioListLoader *	pLoader
Entry *	pNext
class Folder *	pParent
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

Scenario()

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

inline

Definition at line 122 of file C4StartupScenSelDlg.h.

: Entry(pLoader, pParent), fNoMissionAccess(false), nAchievements(0), iMinPlrCount(0) {}

~Scenario()

C4ScenarioListLoader::Scenario::~Scenario ( )

overridedefault

Member Function Documentation

CanOpen()

bool C4ScenarioListLoader::Scenario::CanOpen ( StdStrBuf &  sError, bool &  CanHide  )

overridevirtual

Reimplemented from C4ScenarioListLoader::Entry.

Definition at line 769 of file C4StartupScenSelDlg.cpp.

{
    // safety
    C4StartupScenSelDlg *pDlg = C4StartupScenSelDlg::pInstance;
    if (!pDlg) return false;
    // check mission access
    if (!HasMissionAccess())
    {
        sErrOut.Copy(LoadResStr("IDS_PRC_NOMISSIONACCESS"));
        return false;
    }
    // replay
    if (C4S.Head.Replay)
    {
        // replays can currently not be launched in network mode
        if (pDlg->IsNetworkStart())
        {
            sErrOut.Copy(LoadResStr("IDS_PRC_NONETREPLAY"));
            return false;
        }
    }
    // regular game
    else
    {
        // check player count
        int32_t iPlrCount = SModuleCount(Config.General.Participants);
        int32_t iMaxPlrCount = C4S.Head.MaxPlayer;
        if (C4S.Head.SaveGame)
        {
            // Some scenarios have adjusted MaxPlayerCount to 0 after starting to prevent future joins
            // make sure it's possible to start the savegame anyway
            iMaxPlrCount = std::max<int32_t>(iMinPlrCount, iMaxPlrCount);
 
            // <Sven2> Savegames store a lot of internal stuff. If you updated clonk in the meantime, many things tend to break
            if (C4S.Head.C4XVer[0] != C4XVER1 || C4S.Head.C4XVer[1] != C4XVER2)
            {
                // Only show a warning to let players try it anyways.
                sErrOut.Format(LoadResStr("IDS_MSG_SAVEGAMEVERSIONMISMATCH"), C4S.Head.C4XVer[0], C4S.Head.C4XVer[1]);
                CanHide = false;
            }
        }
        // normal scenarios: At least one player except in network mode, where it is possible to wait for the additional players
        // Melees need at least two
        if ((iPlrCount < iMinPlrCount))
        {
            if (pDlg->IsNetworkStart())
            {
                // network game: Players may yet join in lobby
                // only issue a warning for too few players (by setting the error but not returning false here)
                sErrOut.Format(LoadResStr("IDS_MSG_TOOFEWPLAYERSNET"), (int) iMinPlrCount);
                CanHide = true;
            }
            else
            {
                // for regular games, this is a fatal no-start-cause
                sErrOut.Format(LoadResStr("IDS_MSG_TOOFEWPLAYERS"), (int) iMinPlrCount);
                return false;
            }
        }
        // scenarios (both normal and savegame) may also impose a maximum player restriction
        if (iPlrCount > iMaxPlrCount)
        {
            sErrOut.Format(LoadResStr("IDS_MSG_TOOMANYPLAYERS"), (int) C4S.Head.MaxPlayer);
            return false;
        }
    }
    // Okay, start!
    return true;
}

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

Here is the call graph for this function:

CreateEntryForFile()

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

staticinherited

Definition at line 549 of file C4StartupScenSelDlg.cpp.

{
    // determine entry type by file type
    const char *szFilename = sFilename.getData();
    if (!szFilename || !*szFilename) return nullptr;
    if (WildcardMatch(C4CFN_ScenarioFiles, sFilename.getData())) return new Scenario(pLoader, pParent);
    if (WildcardMatch(C4CFN_FolderFiles, sFilename.getData())) return new SubFolder(pLoader, pParent);
    // regular, open folder (C4Group-packed folders without extensions are not regarded, because they could contain anything!)
    const char *szExt = GetExtension(szFilename);
    if ((!szExt || !*szExt) && DirectoryExists(sFilename.getData()))
    {
        // do not open folders in the mod directory (and the dir itself - thus match minus the separator),
        // as contained files will be discovered anyway
        const char * modsDirectoryPrefix = Config.General.ModsDataPath;
        if (std::strncmp(szFilename, modsDirectoryPrefix, std::strlen(modsDirectoryPrefix) - 1) == 0)
            return nullptr;
        // open folders only if they contain a scenario or folder
        if (DirContainsScenarios(szFilename))
            return new RegularFolder(pLoader, pParent);
    }
    // type not recognized
    return nullptr;
}

References C4CFN_FolderFiles, C4CFN_ScenarioFiles, Config, DirContainsScenarios(), DirectoryExists(), C4Config::General, StdStrBuf::getData(), GetExtension(), C4ConfigGeneral::ModsDataPath, and WildcardMatch().

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

Here is the call graph for this function:

Here is the caller graph for this function:

GetAchievement()

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

overridevirtual

Reimplemented from C4ScenarioListLoader::Entry.

Definition at line 753 of file C4StartupScenSelDlg.cpp.

{
    // return true and fill output parameters if player got the indexed achievement
    if (idx < 0 || idx >= nAchievements) return false;
    *out_facet = fctAchievements[idx];
    *out_description = sAchievementDescriptions[idx].getData();
    return true;
}

GetAuthor()

const StdStrBuf& C4ScenarioListLoader::Entry::GetAuthor ( ) const

inlineinherited

Definition at line 77 of file C4StartupScenSelDlg.h.

{ return sAuthor; }

References C4ScenarioListLoader::Entry::sAuthor.

GetC4S()

const C4Scenario& C4ScenarioListLoader::Scenario::GetC4S ( ) const

inline

Definition at line 135 of file C4StartupScenSelDlg.h.

{ return C4S; } // get scenario core

Referenced by C4StartupScenSelDlg::StartScenario().

Here is the caller graph for this function:

GetDefaultExtension()

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

inlineoverridevirtual

Reimplemented from C4ScenarioListLoader::Entry.

Definition at line 140 of file C4StartupScenSelDlg.h.

{ return "ocs"; }

GetDesc()

const StdStrBuf& C4ScenarioListLoader::Entry::GetDesc ( ) const

inlineinherited

Definition at line 80 of file C4StartupScenSelDlg.h.

{ return sDesc; }

References C4ScenarioListLoader::Entry::sDesc.

GetDifficulty()

int C4ScenarioListLoader::Entry::GetDifficulty ( )

inlineinherited

Definition at line 82 of file C4StartupScenSelDlg.h.

{ return iDifficulty; }

References C4ScenarioListLoader::Entry::iDifficulty.

Referenced by EntrySortFunc().

Here is the caller graph for this function:

GetEntryFilename()

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

inlineinherited

Definition at line 75 of file C4StartupScenSelDlg.h.

{ return sFilename; }

References C4ScenarioListLoader::Entry::sFilename.

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

Here is the caller graph for this function:

GetFolderIndex()

int C4ScenarioListLoader::Entry::GetFolderIndex ( )

inlineinherited

Definition at line 83 of file C4StartupScenSelDlg.h.

{ return iFolderIndex; }

References C4ScenarioListLoader::Entry::iFolderIndex.

Referenced by EntrySortFunc().

Here is the caller graph for this function:

GetIconFacet()

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

inlineinherited

Definition at line 78 of file C4StartupScenSelDlg.h.

{ return fctIcon; }

References C4ScenarioListLoader::Entry::fctIcon.

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

Here is the caller graph for this function:

GetIconIndex()

int C4ScenarioListLoader::Entry::GetIconIndex ( )

inlineinherited

Definition at line 81 of file C4StartupScenSelDlg.h.

{ return iIconIndex; }

References C4ScenarioListLoader::Entry::iIconIndex.

Referenced by EntrySortFunc().

Here is the caller graph for this function:

GetIsFolder()

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

inlinevirtualinherited

Reimplemented in C4ScenarioListLoader::Folder.

Definition at line 72 of file C4StartupScenSelDlg.h.

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

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

Here is the caller graph for this function:

GetName()

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

inlineinherited

Definition at line 74 of file C4StartupScenSelDlg.h.

{ return sName; }

References C4ScenarioListLoader::Entry::sName.

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

Here is the caller graph for this function:

GetNext()

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

inlineinherited

Definition at line 84 of file C4StartupScenSelDlg.h.

{ return pNext; }

References C4ScenarioListLoader::Entry::pNext.

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

Here is the caller graph for this function:

GetOpenText()

StdStrBuf C4ScenarioListLoader::Scenario::GetOpenText ( )

overridevirtual

Implements C4ScenarioListLoader::Entry.

Definition at line 839 of file C4StartupScenSelDlg.cpp.

{
    return StdCopyStrBuf(LoadResStr("IDS_BTN_STARTGAME"));
}

References LoadResStr().

Here is the call graph for this function:

GetOpenTooltip()

StdStrBuf C4ScenarioListLoader::Scenario::GetOpenTooltip ( )

overridevirtual

Implements C4ScenarioListLoader::Entry.

Definition at line 844 of file C4StartupScenSelDlg.cpp.

{
    return StdCopyStrBuf(LoadResStr("IDS_DLGTIP_SCENSELNEXT"));
}

References LoadResStr().

Here is the call graph for this function:

GetParameterDefs()

C4ScenarioParameterDefs* C4ScenarioListLoader::Scenario::GetParameterDefs ( )

inlineoverridevirtual

Reimplemented from C4ScenarioListLoader::Entry.

Definition at line 142 of file C4StartupScenSelDlg.h.

{ return &ParameterDefs; }

GetParameters()

C4ScenarioParameters* C4ScenarioListLoader::Scenario::GetParameters ( )

inlineoverridevirtual

Reimplemented from C4ScenarioListLoader::Entry.

Definition at line 143 of file C4StartupScenSelDlg.h.

{ return &Parameters; }

Referenced by C4StartupScenSelDlg::StartScenario().

Here is the caller graph for this function:

GetParent()

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

inlineinherited

Definition at line 85 of file C4StartupScenSelDlg.h.

{ return pParent; }

References C4ScenarioListLoader::Entry::pParent.

Referenced by C4ScenarioListLoader::FolderBack().

Here is the caller graph for this function:

GetTitlePicture()

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

inlineinherited

Definition at line 79 of file C4StartupScenSelDlg.h.

{ return fctTitle; }

References C4ScenarioListLoader::Entry::fctTitle.

GetTypeName()

StdStrBuf C4ScenarioListLoader::Scenario::GetTypeName ( )

inlineoverridevirtual

Implements C4ScenarioListLoader::Entry.

Definition at line 138 of file C4StartupScenSelDlg.h.

{ return StdCopyStrBuf(LoadResStr("IDS_TYPE_SCENARIO"), true); }

References LoadResStr().

Here is the call graph for this function:

GetVersion()

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

inlineinherited

Definition at line 76 of file C4StartupScenSelDlg.h.

{ return sVersion; }

References C4ScenarioListLoader::Entry::sVersion.

HasMissionAccess()

bool C4ScenarioListLoader::Scenario::HasMissionAccess ( ) const

inlineoverridevirtual

Reimplemented from C4ScenarioListLoader::Entry.

Definition at line 132 of file C4StartupScenSelDlg.h.

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

Referenced by IsHidden().

Here is the caller graph for this function:

HasUnregisteredAccess()

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

inlinevirtualinherited

Definition at line 95 of file C4StartupScenSelDlg.h.

{ return false; }

IsGrayed()

bool C4ScenarioListLoader::Scenario::IsGrayed ( )

inlineoverridevirtual

Reimplemented from C4ScenarioListLoader::Entry.

Definition at line 130 of file C4StartupScenSelDlg.h.

{ return false; } // additional option for graying out

IsHidden()

bool C4ScenarioListLoader::Scenario::IsHidden ( )

inlineoverridevirtual

Reimplemented from C4ScenarioListLoader::Entry.

Definition at line 131 of file C4StartupScenSelDlg.h.

{ return C4S.Head.Secret && !HasMissionAccess(); } // condition for hiding element completely

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

Here is the call graph for this function:

IsScenario()

bool C4ScenarioListLoader::Scenario::IsScenario ( )

inlineoverridevirtual

Reimplemented from C4ScenarioListLoader::Entry.

Definition at line 145 of file C4StartupScenSelDlg.h.

{ return true; }

Load()

bool C4ScenarioListLoader::Entry::Load ( C4Group *  pFromGrp, const StdStrBuf *  psFilename, bool  fLoadEx  )

inherited

Definition at line 431 of file C4StartupScenSelDlg.cpp.

{
    // nothing to do if already loaded
    if (fBaseLoaded && (fExLoaded || !fLoadEx)) return true;
    C4Group Group;
    // group specified: Load as child
    if (pFromGrp)
    {
        assert(psFilename);
        if (!Group.OpenAsChild(pFromGrp, psFilename->getData())) return false;
        // set FN by complete entry name
        this->sFilename.Take(Group.GetFullName());
    }
    else
    {
        // set FN by complete entry name
        if (psFilename) this->sFilename.Copy(*psFilename);
        // no parent group: Direct load from filename
        if (!Group.Open(sFilename.getData())) return false;
    }
    // okay; load standard stuff from group
    bool fNameLoaded=false, fIconLoaded=false;
    if (fBaseLoaded)
    {
        fNameLoaded = fIconLoaded = true;
    }
    else
    {
        // Set default name as filename without extension
        sName.Copy(GetFilename(sFilename.getData()));
        char *szBuf = sName.GrabPointer();
        RemoveExtension(szBuf);
        sName.Take(szBuf);
        // load entry specific stuff that's in the front of the group
        if (!LoadCustomPre(Group))
            return false;
        // Load entry name
        C4ComponentHost DefNames;
        if (C4Language::LoadComponentHost(&DefNames, Group, C4CFN_Title, Config.General.LanguageEx))
            if (DefNames.GetLanguageString(Config.General.LanguageEx, sName))
                fNameLoaded = true;
        // load entry icon
        if (Group.FindEntry(C4CFN_IconPNG) && fctIcon.Load(Group, C4CFN_IconPNG, C4FCT_Full, C4FCT_Full, false, 0))
            fIconLoaded = true;
        else
        {
            C4FacetSurface fctTemp;
            if (Group.FindEntry(C4CFN_ScenarioIcon) && fctTemp.Load(Group, C4CFN_ScenarioIcon, C4FCT_Full, C4FCT_Full, true, 0))
            {
                // old style icon: Blit it on a pieace of paper
                fctTemp.Surface->Lock();
                for (int y=0; y<fctTemp.Hgt; ++y)
                    for (int x=0; x<fctTemp.Wdt; ++x)
                    {
                        uint32_t dwPix = fctTemp.Surface->GetPixDw(x,y, false);
                        // transparency has some tolerance...
                        if (Inside<uint8_t>(dwPix & 0xff, 0xb8, 0xff))
                            if (Inside<uint8_t>((dwPix>>0x08) & 0xff, 0x00, 0x0f))
                                if (Inside<uint8_t>((dwPix>>0x10) & 0xff, 0xb8, 0xff))
                                    fctTemp.Surface->SetPixDw(x,y,0x00ffffff);
                    }
                fctTemp.Surface->Unlock();
                int iIconSize = C4Startup::Get()->Graphics.fctScenSelIcons.Hgt;
                fctIcon.Create(iIconSize, iIconSize, C4FCT_Full, C4FCT_Full);
                C4Startup::Get()->Graphics.fctScenSelIcons.GetPhase(C4StartupScenSel_DefaultIcon_OldIconBG).Draw(fctIcon);
                fctTemp.Draw(fctIcon.Surface, (fctIcon.Wdt-fctTemp.Wdt)/2, (fctIcon.Hgt-fctTemp.Hgt)/2);
                fctTemp.Clear();
                fIconLoaded = true;
            }
        }
        // load any entryx-type-specific custom data (e.g. fallbacks for scenario title, and icon)
        if (!LoadCustom(Group, fNameLoaded, fIconLoaded)) return false;
        fBaseLoaded = true;
    }
    // load extended stuff: title picture
    if (fLoadEx && !fExLoaded)
    {
        // load desc
        C4ComponentHost DefDesc;
        if (C4Language::LoadComponentHost(&DefDesc, Group, C4CFN_ScenarioDesc, Config.General.LanguageEx))
        {
            sDesc.Copy(DefDesc.GetData());
        }
        // load title
        fctTitle.Load(Group, C4CFN_ScenarioTitle,C4FCT_Full,C4FCT_Full,false,true);
        fExLoaded = true;
        // load version
        Group.LoadEntryString(C4CFN_Version, &sVersion);
    }
    // done, success
    return true;
}

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().

Here is the call graph for this function:

Here is the caller graph for this function:

LoadCustom()

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

overridevirtual

Reimplemented from C4ScenarioListLoader::Entry.

Definition at line 732 of file C4StartupScenSelDlg.cpp.

{
    // icon fallback: Standard scenario icon
    if (!fIconLoaded)
    {
        iIconIndex = C4S.Head.Icon;
        fctIcon.Set(C4Startup::Get()->Graphics.fctScenSelIcons.GetSection(C4S.Head.Icon));
    }
    // scenario name fallback to core
    if (!fNameLoaded)
        sName = C4S.Head.Title;
    // difficulty: Set only for regular rounds (not savegame or record) to avoid bogus sorting
    if (!C4S.Head.SaveGame && !C4S.Head.Replay)
        iDifficulty = C4S.Head.Difficulty;
    else
        iDifficulty = 0;
    // minimum required player count
    iMinPlrCount = C4S.GetMinPlayer();
    return true;
}

References C4Startup::Get().

Here is the call graph for this function:

LoadCustomPre()

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

overridevirtual

Reimplemented from C4ScenarioListLoader::Entry.

Definition at line 667 of file C4StartupScenSelDlg.cpp.

{
    // load scenario core first
    StdStrBuf sFileContents;
    if (!rGrp.LoadEntryString(C4CFN_ScenarioCore, &sFileContents)) return false;
    if (!CompileFromBuf_LogWarn<StdCompilerINIRead>(mkParAdapt(C4S, false), sFileContents, (rGrp.GetFullName() + DirSep C4CFN_ScenarioCore).getData()))
        return false;
    // Mission access
    fNoMissionAccess = (!C4S.Head.MissionAccess.empty() && !SIsModule(Config.General.MissionAccess, C4S.Head.MissionAccess.c_str()));
    // Localized parameter definitions. needed for achievements and parameter input boxes.
    // Only show them for "real" scenarios
    if (!C4S.Head.SaveGame && !C4S.Head.Replay)
    {
        // Skipping ahead in regular reading list, so keep other entries in memory
        rGrp.PreCacheEntries(C4CFN_AnyScriptStringTbl, true);
        rGrp.PreCacheEntries(C4CFN_ScenarioParameterDefs, true);
        C4LangStringTable ScenarioLangStringTable;
        C4Language::LoadComponentHost(&ScenarioLangStringTable, rGrp, C4CFN_ScriptStringTbl, Config.General.LanguageEx);
        ParameterDefs.Load(rGrp, &ScenarioLangStringTable);
        // achievement images: Loaded from this entry and parent folder
        nAchievements = 0;
        const C4ScenarioParameterDefs *deflists[] = { pParent ? pParent->GetAchievementDefs() : nullptr, &ParameterDefs };
        for (auto deflist : deflists)
        {
            if (!deflist) continue;
            const C4ScenarioParameterDef *def; size_t idx=0;
            while ((def = deflist->GetParameterDefByIndex(idx++)))
            {
                if (def->IsAchievement())
                {
                    int32_t val = pLoader->GetAchievements().GetValueByID(C4ScenarioParameters::AddFilename2ID(rGrp.GetFullName().getData(), def->GetID()).getData(), def->GetDefault());
                    if (val)
                    {
                        // player has this achievement - find graphics for it
                        const char *achievement_gfx = def->GetAchievement();
                        StdStrBuf sAchievementFilename(C4CFN_Achievements);
                        sAchievementFilename.Replace("*", achievement_gfx);
                        // look in scenario
                        if (!fctAchievements[nAchievements].Load(rGrp, sAchievementFilename.getData(), C4FCT_Height, C4FCT_Full, false, true))
                        {
                            // look in parent folder
                            const C4FacetSurface *fct = nullptr;
                            const C4AchievementGraphics *parent_achv_gfx;
                            if (pParent && (parent_achv_gfx = pParent->GetAchievementGfx())) fct = parent_achv_gfx->FindByName(achievement_gfx);
                            // look in main gfx group file
                            if (!fct) fct = ::GraphicsResource.Achievements.FindByName(achievement_gfx);
                            if (!fct) continue; // achievement graphics not found :(
                            fctAchievements[nAchievements].Set((const C4Facet &)*fct);
                        }
                        // section by achievement index (1-based, since zero means no achievement)
                        if (val>1) fctAchievements[nAchievements].X += fctAchievements[nAchievements].Wdt * (val-1);
                        // description for this achievement is taken from option
                        const C4ScenarioParameterDef::Option *opt = def->GetOptionByValue(val);
                        if (opt) sAchievementDescriptions[nAchievements] = opt->Description;
                        // keep track of achievement count
                        ++nAchievements;
                        if (nAchievements == C4StartupScenSel_MaxAchievements) break;
                    }
                }
            }
        }
    }
    return true;
}

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().

Here is the call graph for this function:

RenameTo()

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

inherited

Definition at line 573 of file C4StartupScenSelDlg.cpp.

{
    // change name+filename
    // some name sanity validation
    if (!szNewName || !*szNewName) return false;
    if (SEqual(szNewName, sName.getData())) return true;
    char fn[_MAX_PATH_LEN];
    SCopy(szNewName, fn, _MAX_PATH);
    // generate new file name
    MakeFilenameFromTitle(fn);
    if (!*fn) return false;
    const char *szExt = GetDefaultExtension();
    if (szExt) { SAppend(".", fn, _MAX_PATH); SAppend(szExt, fn, _MAX_PATH); }
    char fullfn[_MAX_PATH_LEN];
    SCopy(sFilename.getData(), fullfn, _MAX_PATH);
    char *fullfn_fn = GetFilename(fullfn);
    SCopy(fn, fullfn_fn, _MAX_PATH - (fullfn_fn - fullfn));
    StdCopyStrBuf strErr(LoadResStr("IDS_FAIL_RENAME"));
    // check if a rename is due
    if (!ItemIdentical(sFilename.getData(), fullfn))
    {
        // check for duplicate filename
        if (ItemExists(fullfn))
        {
            StdStrBuf sMsg; sMsg.Format(LoadResStr("IDS_ERR_FILEEXISTS"), fullfn);
            ::pGUI->ShowMessageModal(sMsg.getData(), strErr.getData(), C4GUI::MessageDialog::btnOK, C4GUI::Ico_Error);
            return false;
        }
        // OK; then rename
        if (!C4Group_MoveItem(sFilename.getData(), fullfn, true))
        {
            StdStrBuf sMsg; sMsg.Format(LoadResStr("IDS_ERR_RENAMEFILE"), sFilename.getData(), fullfn);
            ::pGUI->ShowMessageModal(sMsg.getData(), strErr.getData(), C4GUI::MessageDialog::btnOK, C4GUI::Ico_Error);
            return false;
        }
        sFilename.Copy(fullfn);
    }
    // update real name in group, if this is a group
    if (C4Group_IsGroup(fullfn))
    {
        C4Group Grp;
        if (!Grp.Open(fullfn))
        {
            StdStrBuf sMsg; sMsg.Format(LoadResStr("IDS_ERR_OPENFILE"), sFilename.getData(), Grp.GetError());
            ::pGUI->ShowMessageModal(sMsg.getData(), strErr.getData(), C4GUI::MessageDialog::btnOK, C4GUI::Ico_Error);
            return false;
        }
        if (!Grp.Delete(C4CFN_Title))
        {
            StdStrBuf sMsg; sMsg.Format(LoadResStr("IDS_ERR_DELOLDTITLE"), sFilename.getData(), Grp.GetError());
            ::pGUI->ShowMessageModal(sMsg.getData(), strErr.getData(), C4GUI::MessageDialog::btnOK, C4GUI::Ico_Error);
            return false;
        }
        if (!SetTitleInGroup(Grp, szNewName)) return false;
        if (!Grp.Close())
        {
            StdStrBuf sMsg; sMsg.Format(LoadResStr("IDS_ERR_WRITENEWTITLE"), sFilename.getData(), Grp.GetError());
            ::pGUI->ShowMessageModal(sMsg.getData(), strErr.getData(), C4GUI::MessageDialog::btnOK, C4GUI::Ico_Error);
            return false;
        }
    }
    // update title
    sName.Copy(szNewName);
    // done
    return true;
}

References _MAX_PATH, _MAX_PATH_LEN, 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().

Here is the call graph for this function:

SetTitleInGroup()

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

virtualinherited

Definition at line 640 of file C4StartupScenSelDlg.cpp.

{
    // default for group files: Create a title text file and set the title in there
    // no title needed if filename is sufficient - except for scenarios, where a Scenario.txt could overwrite the title
    if (!IsScenario())
    {
        StdStrBuf sNameByFile; sNameByFile.Copy(GetFilename(sFilename.getData()));
        char *szBuf = sNameByFile.GrabPointer();
        RemoveExtension(szBuf);
        sNameByFile.Take(szBuf);
        if (SEqual(szNewTitle, sNameByFile.getData())) return true;
    }
    // okay, make a title
    StdStrBuf sTitle; sTitle.Format("%s:%s", Config.General.Language, szNewTitle);
    if (!rGrp.Add(C4CFN_WriteTitle, sTitle, false, true))
    {
        StdStrBuf sMsg; sMsg.Format(LoadResStr("IDS_ERR_ERRORADDINGNEWTITLEFORFIL"), sFilename.getData(), rGrp.GetError());
        ::pGUI->ShowMessageModal(sMsg.getData(), LoadResStr("IDS_FAIL_RENAME"), C4GUI::MessageDialog::btnOK, C4GUI::Ico_Error);
        return false;
    }
    return true;
}

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().

Here is the call graph for this function:

Start()

bool C4ScenarioListLoader::Scenario::Start ( )

overridevirtual

Implements C4ScenarioListLoader::Entry.

Definition at line 762 of file C4StartupScenSelDlg.cpp.

{
    // gogo!
    if (!(C4StartupScenSelDlg::pInstance)) return false;
    return (C4StartupScenSelDlg::pInstance)->StartScenario(this);
}

References C4StartupScenSelDlg::pInstance.

Member Data Documentation

fBaseLoaded

bool C4ScenarioListLoader::Entry::fBaseLoaded

protectedinherited

Definition at line 59 of file C4StartupScenSelDlg.h.

fctIcon

C4FacetSurface C4ScenarioListLoader::Entry::fctIcon

protectedinherited

Definition at line 58 of file C4StartupScenSelDlg.h.

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

fctTitle

C4FacetSurface C4ScenarioListLoader::Entry::fctTitle

protectedinherited

Definition at line 58 of file C4StartupScenSelDlg.h.

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

fExLoaded

bool C4ScenarioListLoader::Entry::fExLoaded

protectedinherited

Definition at line 59 of file C4StartupScenSelDlg.h.

iDifficulty

int C4ScenarioListLoader::Entry::iDifficulty

protectedinherited

Definition at line 61 of file C4StartupScenSelDlg.h.

Referenced by C4ScenarioListLoader::Entry::Entry(), and C4ScenarioListLoader::Entry::GetDifficulty().

iFolderIndex

int C4ScenarioListLoader::Entry::iFolderIndex

protectedinherited

Definition at line 62 of file C4StartupScenSelDlg.h.

Referenced by C4ScenarioListLoader::Entry::Entry(), and C4ScenarioListLoader::Entry::GetFolderIndex().

iIconIndex

int C4ScenarioListLoader::Entry::iIconIndex

protectedinherited

Definition at line 60 of file C4StartupScenSelDlg.h.

Referenced by C4ScenarioListLoader::Entry::Entry(), and C4ScenarioListLoader::Entry::GetIconIndex().

pLoader

class C4ScenarioListLoader* C4ScenarioListLoader::Entry::pLoader

protectedinherited

Definition at line 50 of file C4StartupScenSelDlg.h.

pNext

Entry* C4ScenarioListLoader::Entry::pNext

protectedinherited

Definition at line 51 of file C4StartupScenSelDlg.h.

Referenced by C4ScenarioListLoader::Entry::Entry(), C4ScenarioListLoader::Folder::GetEntryCount(), C4ScenarioListLoader::Entry::GetNext(), C4ScenarioListLoader::Folder::Sort(), and C4ScenarioListLoader::Entry::~Entry().

pParent

class Folder* C4ScenarioListLoader::Entry::pParent

protectedinherited

Definition at line 52 of file C4StartupScenSelDlg.h.

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

sAuthor

StdCopyStrBuf C4ScenarioListLoader::Entry::sAuthor

protectedinherited

Definition at line 57 of file C4StartupScenSelDlg.h.

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

sDesc

StdCopyStrBuf C4ScenarioListLoader::Entry::sDesc

protectedinherited

Definition at line 57 of file C4StartupScenSelDlg.h.

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

sFilename

StdCopyStrBuf C4ScenarioListLoader::Entry::sFilename

protectedinherited

Definition at line 57 of file C4StartupScenSelDlg.h.

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

sName

StdCopyStrBuf C4ScenarioListLoader::Entry::sName

protectedinherited

Definition at line 57 of file C4StartupScenSelDlg.h.

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

sVersion

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:

• C4StartupScenSelDlg.h
• C4StartupScenSelDlg.cpp