cMapDecorator Struct Reference

Encapsulates a map decorator. More...

#include <Map.h>

Public Types
enum class	eType { E_TYPE_PLAYER = 0x00 , E_TYPE_ITEM_FRAME = 0x01 , E_TYPE_PLAYER_OUTSIDE = 0x06 }

Public Member Functions
	cMapDecorator (eType a_Type, unsigned int a_X, unsigned int a_Z, int a_Rot)
unsigned int	GetPixelX (void) const
unsigned int	GetPixelZ (void) const
int	GetRot (void) const
eType	GetType (void) const

Private Attributes
unsigned int	m_PixelX
unsigned int	m_PixelZ
int	m_Rot
eType	m_Type

Detailed Description

Encapsulates a map decorator.

A map decorator represents an object drawn on the map that can move freely. (e.g. player trackers and item frame pointers)

Excluding manually placed decorators, decorators are automatically managed (allocated and freed) by their parent cMap instance.

Definition at line 34 of file Map.h.

Member Enumeration Documentation

eType

enum cMapDecorator::eType

strong

Enumerator
E_TYPE_PLAYER
E_TYPE_ITEM_FRAME
E_TYPE_PLAYER_OUTSIDE	Player outside of the boundaries of the map.

Definition at line 38 of file Map.h.

Constructor & Destructor Documentation

cMapDecorator()

cMapDecorator::cMapDecorator ( eType  a_Type, unsigned int  a_X, unsigned int  a_Z, int  a_Rot  )

inline

Definition at line 47 of file Map.h.

Member Function Documentation

GetPixelX()

unsigned int cMapDecorator::GetPixelX ( void  ) const

inline

Definition at line 57 of file Map.h.

GetPixelZ()

unsigned int cMapDecorator::GetPixelZ ( void  ) const

inline

Definition at line 58 of file Map.h.

GetRot()

int cMapDecorator::GetRot ( void  ) const

inline

Definition at line 60 of file Map.h.

GetType()

eType cMapDecorator::GetType ( void  ) const

inline

Definition at line 62 of file Map.h.

Member Data Documentation

m_PixelX

unsigned int cMapDecorator::m_PixelX

private

Definition at line 68 of file Map.h.

m_PixelZ

unsigned int cMapDecorator::m_PixelZ

private

Definition at line 69 of file Map.h.

m_Rot

int cMapDecorator::m_Rot

private

Definition at line 71 of file Map.h.

m_Type

eType cMapDecorator::m_Type

private

Definition at line 66 of file Map.h.

---

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

• src/Map.h