IMap Class Reference

#include <map.h>

Inheritance diagram for IMap:

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

Constructor & Destructor Documentation

~IMap()

virtual IMap::~IMap ( )

virtualdefault

Member Function Documentation

BaseName()

virtual const char * IMap::BaseName ( ) const

pure virtual

Returns the base name of the currently loaded map.

Returns

Base map name, e.g. my_map.

Implemented in CMap.

Crc()

virtual unsigned IMap::Crc ( ) const

pure virtual

Implemented in CMap.

File()

virtual IOHANDLE IMap::File ( ) const

pure virtual

Implemented in CMap.

FindItem()

virtual void * IMap::FindItem ( int Type, int Id )

pure virtual

Implemented in CMap.

FindItemIndex()

virtual int IMap::FindItemIndex ( int Type, int Id )

pure virtual

Implemented in CMap.

FullName()

virtual const char * IMap::FullName ( ) const

pure virtual

Returns the full name of the currently loaded map.

Returns

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

Implemented in CMap.

GetData()

virtual void * IMap::GetData ( int Index )

pure virtual

Implemented in CMap.

GetDataSize()

virtual int IMap::GetDataSize ( int Index ) const

pure virtual

Implemented in CMap.

GetDataString()

virtual const char * IMap::GetDataString ( int Index )

pure virtual

Implemented in CMap.

GetDataSwapped()

virtual void * IMap::GetDataSwapped ( int Index )

pure virtual

Implemented in CMap.

GetItem()

virtual void * IMap::GetItem ( int Index, int * pType = nullptr, int * pId = nullptr, CUuid * pUuid = nullptr )

pure virtual

Implemented in CMap.

GetItemSize()

virtual int IMap::GetItemSize ( int Index )

pure virtual

Implemented in CMap.

GetType()

virtual void IMap::GetType ( int Type, int * pStart, int * pNum )

pure virtual

Implemented in CMap.

IsLoaded()

virtual bool IMap::IsLoaded ( ) const

pure virtual

Implemented in CMap.

Load() [1/2]

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

nodiscardpure virtual

Implemented in CMap.

Load() [2/2]

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

nodiscardpure virtual

Implemented in CMap.

NumData()

virtual int IMap::NumData ( ) const

pure virtual

Implemented in CMap.

NumItems()

virtual int IMap::NumItems ( ) const

pure virtual

Implemented in CMap.

Path()

virtual const char * IMap::Path ( ) const

pure virtual

Returns the path of the currently loaded map.

Returns

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

Implemented in CMap.

Sha256()

virtual SHA256_DIGEST IMap::Sha256 ( ) const

pure virtual

Implemented in CMap.

Size()

virtual int IMap::Size ( ) const

pure virtual

Implemented in CMap.

Unload()

virtual void IMap::Unload ( )

pure virtual

Implemented in CMap.

UnloadData()

virtual void IMap::UnloadData ( int Index )

pure virtual

Implemented in CMap.

---

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

• src/engine/map.h