birkeh/o3de
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Integrating up through commit 90f050496

Browse Source
This commit is contained in:
alexpete
2021-04-07 14:03:29 -07:00
parent 8f2ed080a9
commit c2cbd430fe
2694 changed files with 285622 additions and 176874 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Code/CryEngine/CryCommon/ILevelSystem.h
+32 -169
View File
@@ -20,8 +20,8 @@
#include <CrySizer.h>
#include <IXml.h>
#include <AzCore/Asset/AssetCommon.h>
struct ILevelRotationFile;
struct IConsoleCmdArgs;
namespace AZ::IO
@@ -29,212 +29,75 @@ namespace AZ::IO
struct IArchive;
}
struct ILevelRotation
{
virtual ~ILevelRotation() {}
typedef uint32 TExtInfoId;
struct IExtendedInfo
{
};
typedef uint8 TRandomisationFlags;
enum EPlaylistRandomisationFlags
{
ePRF_None = 0,
ePRF_Shuffle = 1 << 0,
ePRF_MaintainPairs = 1 << 1,
};
virtual bool Load([[maybe_unused]] ILevelRotationFile* file) { return false; }
virtual bool LoadFromXmlRootNode(const XmlNodeRef rootNode, [[maybe_unused]] const char* altRootTag) { return false; }
virtual void Reset() {}
virtual int AddLevel([[maybe_unused]] const char* level) { return 0; }
virtual void AddGameMode([[maybe_unused]] int level, [[maybe_unused]] const char* gameMode) {}
virtual int AddLevel([[maybe_unused]] const char* level, [[maybe_unused]] const char* gameMode) { return 0; }
//call to set the playlist ready for a new session
virtual void Initialise([[maybe_unused]] int nSeed) {}
virtual bool First() { return false; }
virtual bool Advance() { return false; }
virtual bool AdvanceAndLoopIfNeeded() { return false; }
virtual const char* GetNextLevel() const { return nullptr; }
virtual const char* GetNextGameRules() const { return nullptr; }
virtual int GetLength() const { return 0; }
virtual int GetTotalGameModeEntries() const { return 0; }
virtual int GetNext() const { return 0; }
virtual const char* GetLevel([[maybe_unused]] uint32 idx, [[maybe_unused]] bool accessShuffled = true) const { return nullptr; }
virtual int GetNGameRulesForEntry([[maybe_unused]] uint32 idx, [[maybe_unused]] bool accessShuffled = true) const { return 0; }
virtual const char* GetGameRules([[maybe_unused]] uint32 idx, [[maybe_unused]] uint32 iMode, [[maybe_unused]] bool accessShuffled = true) const { return nullptr; }
virtual const char* GetNextGameRulesForEntry([[maybe_unused]] int idx) const { return nullptr; }
virtual const int NumAdvancesTaken() const { return 0; }
virtual void ResetAdvancement() {}
virtual bool IsRandom() const { return false; }
virtual ILevelRotation::TRandomisationFlags GetRandomisationFlags() const { return ePRF_None; }
virtual void SetRandomisationFlags([[maybe_unused]] TRandomisationFlags flags) {}
virtual void ChangeLevel([[maybe_unused]] IConsoleCmdArgs* pArgs = NULL) {}
virtual bool NextPairMatch() const { return false; }
};
// [LYN-2376] Remove once legacy slice support is removed
struct ILevelInfo
{
virtual ~ILevelInfo() {}
typedef std::vector<string> TStringVec;
struct TGameTypeInfo
{
string name;
string xmlFile;
int cgfCount;
void GetMemoryUsage(ICrySizer* pSizer) const
{
pSizer->AddObject(name);
pSizer->AddObject(xmlFile);
}
};
struct SMinimapInfo
{
SMinimapInfo()
: fStartX(0)
, fStartY(0)
, fEndX(1)
, fEndY(1)
, fDimX(1)
, fDimY(1)
, iWidth(1024)
, iHeight(1024) {}
string sMinimapName;
int iWidth;
int iHeight;
float fStartX;
float fStartY;
float fEndX;
float fEndY;
float fDimX;
float fDimY;
};
virtual ~ILevelInfo() = default;
virtual const char* GetName() const = 0;
virtual const bool IsOfType(const char* sType) const = 0;
virtual const char* GetPath() const = 0;
virtual const char* GetPaks() const = 0;
virtual const char* GetDisplayName() const = 0;
virtual const char* GetPreviewImagePath() const = 0;
virtual const char* GetBackgroundImagePath() const = 0;
virtual const char* GetMinimapImagePath() const = 0;
//virtual const ILevelInfo::TStringVec& GetMusicLibs() const = 0; // Gets reintroduced when level specific music data loading is implemented.
virtual const bool MetadataLoaded() const = 0;
virtual bool GetIsModLevel() const = 0;
virtual const uint32 GetScanTag() const = 0;
virtual const uint32 GetLevelTag() const = 0;
virtual int GetGameTypeCount() const = 0;
virtual const ILevelInfo::TGameTypeInfo* GetGameType(int gameType) const = 0;
virtual bool SupportsGameType(const char* gameTypeName) const = 0;
virtual const ILevelInfo::TGameTypeInfo* GetDefaultGameType() const = 0;
virtual ILevelInfo::TStringVec GetGameRules() const = 0;
virtual bool HasGameRules() const = 0;
virtual const ILevelInfo::SMinimapInfo& GetMinimapInfo() const = 0;
virtual const char* GetDefaultGameRules() const = 0;
virtual const char* GetAssetName() const = 0;
};
struct ILevel
{
virtual ~ILevel() {}
virtual void Release() = 0;
virtual ILevelInfo* GetLevelInfo() = 0;
};
/*!
* Extend this class and call ILevelSystem::AddListener() to receive level system related events.
*/
struct ILevelSystemListener
{
virtual ~ILevelSystemListener() {}
virtual ~ILevelSystemListener() = default;
//! Called when loading a level fails due to it not being found.
virtual void OnLevelNotFound([[maybe_unused]] const char* levelName) {}
//! Called after ILevelSystem::PrepareNextLevel() completes.
virtual void OnPrepareNextLevel([[maybe_unused]] ILevelInfo* pLevel) {}
virtual void OnPrepareNextLevel([[maybe_unused]] const char* levelName) {}
//! Called after ILevelSystem::OnLoadingStart() completes, before the level actually starts loading.
virtual void OnLoadingStart([[maybe_unused]] ILevelInfo* pLevel) {}
virtual void OnLoadingStart([[maybe_unused]] const char* levelName) {}
//! Called after the level finished
virtual void OnLoadingComplete([[maybe_unused]] ILevel* pLevel) {}
virtual void OnLoadingComplete([[maybe_unused]] const char* levelName) {}
//! Called when there's an error loading a level, with the level info and a description of the error.
virtual void OnLoadingError([[maybe_unused]] ILevelInfo* pLevel, [[maybe_unused]] const char* error) {}
virtual void OnLoadingError([[maybe_unused]] const char* levelName, [[maybe_unused]] const char* error) {}
//! Called whenever the loading status of a level changes. progressAmount goes from 0->100.
virtual void OnLoadingProgress([[maybe_unused]] ILevelInfo* pLevel, [[maybe_unused]] int progressAmount) {}
virtual void OnLoadingProgress([[maybe_unused]] const char* levelName, [[maybe_unused]] int progressAmount) {}
//! Called after a level is unloaded, before the data is freed.
virtual void OnUnloadComplete([[maybe_unused]] ILevel* pLevel) {}
virtual void OnUnloadComplete([[maybe_unused]] const char* levelName) {}
void GetMemoryUsage([[maybe_unused]] ICrySizer* pSizer) const { }
};
struct ILevelSystem
: public ILevelSystemListener
{
enum
{
TAG_MAIN = 'MAIN',
TAG_UNKNOWN = 'ZZZZ'
};
static constexpr char LevelsDirectoryName[] = "levels";
static constexpr char LevelPakName[] = "level.pak";
virtual ~ILevelSystem() = default;
virtual void Release() = 0;
virtual void Rescan(const char* levelsFolder, const uint32 tag) = 0;
virtual void ScanFolder(const char* subfolder, bool modFolder, const uint32 tag) = 0;
virtual void PopulateLevels(string searchPattern, string& folder, AZ::IO::IArchive* pPak, bool& modFolder, const uint32& tag, bool fromFileSystemOnly) = 0;
virtual void LoadRotation() {}
virtual int GetLevelCount() = 0;
virtual DynArray<string>* GetLevelTypeList() = 0;
virtual ILevelInfo* GetLevelInfo(int level) = 0;
virtual ILevelInfo* GetLevelInfo(const char* levelName) = 0;
virtual void AddListener(ILevelSystemListener* pListener) = 0;
virtual void RemoveListener(ILevelSystemListener* pListener) = 0;
virtual ILevel* GetCurrentLevel() const = 0;
virtual ILevel* LoadLevel(const char* levelName) = 0;
virtual void UnLoadLevel() = 0;
virtual ILevel* SetEditorLoadedLevel(const char* levelName, bool bReadLevelInfoMetaData = false) = 0;
virtual bool LoadLevel(const char* levelName) = 0;
virtual void UnloadLevel() = 0;
virtual bool IsLevelLoaded() = 0;
virtual void PrepareNextLevel(const char* levelName) = 0;
virtual ILevelRotation* GetLevelRotation() { return nullptr; }
virtual ILevelRotation* FindLevelRotationForExtInfoId([[maybe_unused]] const ILevelRotation::TExtInfoId findId) { return nullptr; }
virtual bool AddExtendedLevelRotationFromXmlRootNode(const XmlNodeRef rootNode, [[maybe_unused]] const char* altRootTag, [[maybe_unused]] const ILevelRotation::TExtInfoId extInfoId) { return false; }
virtual void ClearExtendedLevelRotations() {}
virtual ILevelRotation* CreateNewRotation([[maybe_unused]] const ILevelRotation::TExtInfoId id) { return nullptr; }
// Retrieve`s last level level loading time.
virtual float GetLastLevelLoadTime() = 0;
virtual const char* GetCurrentLevelName() const = 0;
// If the level load failed then we need to have a different shutdown procedure vs when a level is naturally unloaded
virtual void SetLevelLoadFailed(bool loadFailed) = 0;
virtual bool GetLevelLoadFailed() = 0;
virtual AZ::Data::AssetType GetLevelAssetType() const = 0;
static const char* GetLevelsDirectoryName()
{
return LevelsDirectoryName;
}
// [LYN-2376] Deprecated methods, to be removed once slices are removed:
virtual void Rescan(const char* levelsFolder) = 0;
virtual int GetLevelCount() = 0;
virtual ILevelInfo* GetLevelInfo(int level) = 0;
virtual ILevelInfo* GetLevelInfo(const char* levelName) = 0;
protected:
static constexpr const char* LevelsDirectoryName = "levels";
};
#endif // CRYINCLUDE_CRYACTION_ILEVELSYSTEM_H