CMap Class Reference

#include <map.h>

Inheritance diagram for CMap:

Collaboration diagram for CMap:

Public Member Functions
	CMap ()
	~CMap () override
int	GetDataSize (int Index) const override
void *	GetData (int Index) override
void *	GetDataSwapped (int Index) override
const char *	GetDataString (int Index) override
void	UnloadData (int Index) override
int	NumData () const override
int	GetItemSize (int Index) override
void *	GetItem (int Index, int *pType=nullptr, int *pId=nullptr) override
void	GetType (int Type, int *pStart, int *pNum) override
int	FindItemIndex (int Type, int Id) override
void *	FindItem (int Type, int Id) override
int	NumItems () const override
bool	Load (const char *pFullName, IStorage *pStorage, const char *pPath, int StorageType) override
bool	Load (IStorage *pStorage, const char *pPath, int StorageType) override
void	Unload () override
bool	IsLoaded () const override
IOHANDLE	File () const override
const char *	FullName () const override
const char *	BaseName () const override
const char *	Path () const override
SHA256_DIGEST	Sha256 () const override
unsigned	Crc () const override
int	Size () const override
Public Member Functions inherited from IMap
virtual	~IMap ()=default

Static Public Member Functions
static void	ExtractTiles (class CTile *pDest, size_t DestSize, const class CTile *pSrc, size_t SrcSize)

Private Attributes
CDataFileReader	m_DataFile

Constructor & Destructor Documentation

CMap()

CMap::CMap ( )

default

~CMap()

CMap::~CMap ( )

override

Member Function Documentation

BaseName()

const char * CMap::BaseName ( ) const

overridevirtual

Returns the base name of the currently loaded map.

Returns

Base map name, e.g. my_map.

Implements IMap.

Crc()

unsigned CMap::Crc ( ) const

overridevirtual

Implements IMap.

ExtractTiles()

void CMap::ExtractTiles ( class CTile * pDest, size_t DestSize, const class CTile * pSrc, size_t SrcSize )

static

File()

IOHANDLE CMap::File ( ) const

overridevirtual

Implements IMap.

FindItem()

void * CMap::FindItem ( int Type, int Id )

overridevirtual

Implements IMap.

FindItemIndex()

int CMap::FindItemIndex ( int Type, int Id )

overridevirtual

Implements IMap.

FullName()

const char * CMap::FullName ( ) const

overridevirtual

Returns the full name of the currently loaded map.

Returns

Full map name, e.g. subfolder1/subfolder2/my_map.

Implements IMap.

GetData()

void * CMap::GetData ( int Index )

overridevirtual

Implements IMap.

GetDataSize()

int CMap::GetDataSize ( int Index ) const

overridevirtual

Implements IMap.

GetDataString()

const char * CMap::GetDataString ( int Index )

overridevirtual

Implements IMap.

GetDataSwapped()

void * CMap::GetDataSwapped ( int Index )

overridevirtual

Implements IMap.

GetItem()

void * CMap::GetItem ( int Index, int * pType = nullptr, int * pId = nullptr )

overridevirtual

Implements IMap.

GetItemSize()

int CMap::GetItemSize ( int Index )

overridevirtual

Implements IMap.

GetType()

void CMap::GetType ( int Type, int * pStart, int * pNum )

overridevirtual

Implements IMap.

IsLoaded()

bool CMap::IsLoaded ( ) const

overridevirtual

Implements IMap.

Load() [1/2]

bool CMap::Load ( const char * pFullName, IStorage * pStorage, const char * pPath, int StorageType )

nodiscardoverridevirtual

Implements IMap.

Load() [2/2]

bool CMap::Load ( IStorage * pStorage, const char * pPath, int StorageType )

nodiscardoverridevirtual

Implements IMap.

NumData()

int CMap::NumData ( ) const

overridevirtual

Implements IMap.

NumItems()

int CMap::NumItems ( ) const

overridevirtual

Implements IMap.

Path()

const char * CMap::Path ( ) const

overridevirtual

Returns the path of the currently loaded map.

Returns

Map path, e.g. maps/subfolder1/subfolder2/my_map.map.

Implements IMap.

Sha256()

SHA256_DIGEST CMap::Sha256 ( ) const

overridevirtual

Implements IMap.

Size()

int CMap::Size ( ) const

overridevirtual

Implements IMap.

Unload()

void CMap::Unload ( )

overridevirtual

Implements IMap.

UnloadData()

void CMap::UnloadData ( int Index )

overridevirtual

Implements IMap.

Member Data Documentation

m_DataFile

CDataFileReader CMap::m_DataFile

private

---

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

• src/engine/shared/map.h
• src/engine/shared/map.cpp