CScreenMap Class


Overview

Note

The CScreenMap class handles the local area map and map note management

The structure used for this class is CScreenMap


Quick Reference

Quick Ref

void CScreenMap::CScreenMap()

virtual void CScreenMap::CancelEngine()

void CScreenMap::CenterViewPort(CPoint& ptPoint)

virtual int CScreenMap::CheckMouseLButton()

virtual int CScreenMap::CheckMouseMove()

virtual int CScreenMap::CheckMouseRButton()

virtual int CScreenMap::CheckMouseWheel()

virtual int CScreenMap::CheckSystemKeyCapsLock()

virtual int CScreenMap::CheckSystemKeyCtrl()

virtual int CScreenMap::CheckSystemKeyShift()

bool CScreenMap::DisplayExploredMap()

virtual void CScreenMap::EngineActivated()

virtual void CScreenMap::EngineDeactivated()

virtual void CScreenMap::EngineDestroyed()

virtual void CScreenMap::EngineGameInit()

virtual void CScreenMap::EngineGameUninit()

virtual void CScreenMap::EngineInitialized()

virtual int CScreenMap::GetCapsLockKey()

int CScreenMap::GetColorChoice()

virtual int CScreenMap::GetCtrlKey()

virtual short CScreenMap::GetNumVirtualKeys()

virtual int CScreenMap::GetShiftKey()

virtual CKeyInfo* CScreenMap::GetVirtualKeys()

virtual int* CScreenMap::GetVirtualKeysFlags()

int CScreenMap::IsNoteVisible(int x, int y)

void CScreenMap::OnColorChoice(int sequence)

virtual bool CScreenMap::OnEvent(SDL_Event* e)

virtual void CScreenMap::OnKeyDown(int nKeysFlags)

virtual void CScreenMap::OnKeyUp(int nKeysFlags)

virtual void CScreenMap::OnLButtonDblClk(CPoint cPoint)

virtual void CScreenMap::OnLButtonDown(CPoint cPoint)

virtual void CScreenMap::OnLButtonUp(CPoint cPoint)

void CScreenMap::OnMapAddNote(int x, int y)

virtual void CScreenMap::OnMouseMove(CPoint cPoint)

virtual void CScreenMap::OnMouseWheel(int bForward, long nTicks, unsigned long nLines, unsigned short wFlags)

virtual void CScreenMap::OnPortraitLClick(unsigned long id)

virtual void CScreenMap::OnPortraitLDblClick(unsigned long id)

virtual void CScreenMap::OnRButtonDown(CPoint cPoint)

virtual void CScreenMap::OnRButtonUp(CPoint cPoint)

virtual void CScreenMap::OnRestButtonClick()

void CScreenMap::OnUserNoteClick(int id, int x, int y)

void CScreenMap::OnUserNoteDeleteButtonClick()

void CScreenMap::OnUserNoteDoneButtonClick()

int CScreenMap::RenderAreaMap(CRect r)

void CScreenMap::RenderCharacters(CRect& rClip)

unsigned char CScreenMap::RenderFogOfWar(CVidMode* pVidMode, CRect& r)

void CScreenMap::RenderViewRect(CVidMode* pVidMode, CPoint& ptStart, CRect& rClipBase, CRect& rWorldView)

void CScreenMap::SetMap(CGameArea* pArea)

virtual void CScreenMap::SetSystemKeyCapsLock(int bValue)

virtual void CScreenMap::SetSystemKeyCtrl(unsigned char bValue)

virtual void CScreenMap::SetSystemKeyShift(int bValue)

virtual void CScreenMap::TimerAsynchronousUpdate()

virtual void CScreenMap::TimerSynchronousUpdate()

void CScreenMap::ToggleDisplayExploredMap()

void CScreenMap::UpdateMainPanel()

CPoint CScreenMap::WorldToMap(CPoint pt)


Constructors

Name

Description

CScreenMap::CScreenMap

Constructs a CScreenMap object

CScreenMap::CScreenMap

Constructs a CScreenMap object

void CScreenMap::CScreenMap();

Remarks

Constructs a CScreenMap object


Methods

Name

Description

CScreenMap::CancelEngine

CScreenMap::CenterViewPort

CScreenMap::CheckMouseLButton

CScreenMap::CheckMouseMove

CScreenMap::CheckMouseRButton

CScreenMap::CheckMouseWheel

CScreenMap::CheckSystemKeyCapsLock

CScreenMap::CheckSystemKeyCtrl

CScreenMap::CheckSystemKeyShift

CScreenMap::DisplayExploredMap

CScreenMap::EngineActivated

CScreenMap::EngineDeactivated

CScreenMap::EngineDestroyed

CScreenMap::EngineGameInit

CScreenMap::EngineGameUninit

CScreenMap::EngineInitialized

CScreenMap::GetCapsLockKey

CScreenMap::GetColorChoice

CScreenMap::GetCtrlKey

CScreenMap::GetNumVirtualKeys

CScreenMap::GetShiftKey

CScreenMap::GetVirtualKeys

CScreenMap::GetVirtualKeysFlags

CScreenMap::IsNoteVisible

CScreenMap::OnColorChoice

CScreenMap::OnEvent

CScreenMap::OnKeyDown

CScreenMap::OnKeyUp

CScreenMap::OnLButtonDblClk

CScreenMap::OnLButtonDown

CScreenMap::OnLButtonUp

CScreenMap::OnMapAddNote

CScreenMap::OnMouseMove

CScreenMap::OnMouseWheel

CScreenMap::OnPortraitLClick

CScreenMap::OnPortraitLDblClick

CScreenMap::OnRButtonDown

CScreenMap::OnRButtonUp

CScreenMap::OnRestButtonClick

CScreenMap::OnUserNoteClick

CScreenMap::OnUserNoteDeleteButtonClick

CScreenMap::OnUserNoteDoneButtonClick

CScreenMap::RenderAreaMap

CScreenMap::RenderCharacters

CScreenMap::RenderFogOfWar

CScreenMap::RenderViewRect

CScreenMap::SetMap

CScreenMap::SetSystemKeyCapsLock

CScreenMap::SetSystemKeyCtrl

CScreenMap::SetSystemKeyShift

CScreenMap::TimerAsynchronousUpdate

CScreenMap::TimerSynchronousUpdate

CScreenMap::ToggleDisplayExploredMap

CScreenMap::UpdateMainPanel

CScreenMap::WorldToMap


CScreenMap::CancelEngine

x;

Parameters

Return Value

Returns

Remarks


CScreenMap::CenterViewPort

x;

Parameters

Return Value

Returns

Remarks


CScreenMap::CheckMouseLButton

x;

Parameters

Return Value

Returns

Remarks


CScreenMap::CheckMouseMove

x;

Parameters

Return Value

Returns

Remarks


CScreenMap::CheckMouseRButton

x;

Parameters

Return Value

Returns

Remarks


CScreenMap::CheckMouseWheel

x;

Parameters

Return Value

Returns

Remarks


CScreenMap::CheckSystemKeyCapsLock

x;

Parameters

Return Value

Returns

Remarks


CScreenMap::CheckSystemKeyCtrl

x;

Parameters

Return Value

Returns

Remarks


CScreenMap::CheckSystemKeyShift

x;

Parameters

Return Value

Returns

Remarks


CScreenMap::DisplayExploredMap

x;

Parameters

Return Value

Returns

Remarks


CScreenMap::EngineActivated

x;

Parameters

Return Value

Returns

Remarks


CScreenMap::EngineDeactivated

x;

Parameters

Return Value

Returns

Remarks


CScreenMap::EngineDestroyed

x;

Parameters

Return Value

Returns

Remarks


CScreenMap::EngineGameInit

x;

Parameters

Return Value

Returns

Remarks


CScreenMap::EngineGameUninit

x;

Parameters

Return Value

Returns

Remarks


CScreenMap::EngineInitialized

x;

Parameters

Return Value

Returns

Remarks


CScreenMap::GetCapsLockKey

x;

Parameters

Return Value

Returns

Remarks


CScreenMap::GetColorChoice

x;

Parameters

Return Value

Returns

Remarks


CScreenMap::GetCtrlKey

x;

Parameters

Return Value

Returns

Remarks


CScreenMap::GetNumVirtualKeys

x;

Parameters

Return Value

Returns

Remarks


CScreenMap::GetShiftKey

x;

Parameters

Return Value

Returns

Remarks


CScreenMap::GetVirtualKeys

x;

Parameters

Return Value

Returns

Remarks


CScreenMap::GetVirtualKeysFlags

x;

Parameters

Return Value

Returns

Remarks


CScreenMap::IsNoteVisible

x;

Parameters

Return Value

Returns

Remarks


CScreenMap::OnColorChoice

x;

Parameters

Return Value

Returns

Remarks


CScreenMap::OnEvent

x;

Parameters

Return Value

Returns

Remarks


CScreenMap::OnKeyDown

x;

Parameters

Return Value

Returns

Remarks


CScreenMap::OnKeyUp

x;

Parameters

Return Value

Returns

Remarks


CScreenMap::OnLButtonDblClk

x;

Parameters

Return Value

Returns

Remarks


CScreenMap::OnLButtonDown

x;

Parameters

Return Value

Returns

Remarks


CScreenMap::OnLButtonUp

x;

Parameters

Return Value

Returns

Remarks


CScreenMap::OnMapAddNote

x;

Parameters

Return Value

Returns

Remarks


CScreenMap::OnMouseMove

x;

Parameters

Return Value

Returns

Remarks


CScreenMap::OnMouseWheel

x;

Parameters

Return Value

Returns

Remarks


CScreenMap::OnPortraitLClick

x;

Parameters

Return Value

Returns

Remarks


CScreenMap::OnPortraitLDblClick

x;

Parameters

Return Value

Returns

Remarks


CScreenMap::OnRButtonDown

x;

Parameters

Return Value

Returns

Remarks


CScreenMap::OnRButtonUp

x;

Parameters

Return Value

Returns

Remarks


CScreenMap::OnRestButtonClick

x;

Parameters

Return Value

Returns

Remarks


CScreenMap::OnUserNoteClick

x;

Parameters

Return Value

Returns

Remarks


CScreenMap::OnUserNoteDeleteButtonClick

x;

Parameters

Return Value

Returns

Remarks


CScreenMap::OnUserNoteDoneButtonClick

x;

Parameters

Return Value

Returns

Remarks


CScreenMap::RenderAreaMap

x;

Parameters

Return Value

Returns

Remarks


CScreenMap::RenderCharacters

x;

Parameters

Return Value

Returns

Remarks


CScreenMap::RenderFogOfWar

x;

Parameters

Return Value

Returns

Remarks


CScreenMap::RenderViewRect

x;

Parameters

Return Value

Returns

Remarks


CScreenMap::SetMap

x;

Parameters

Return Value

Returns

Remarks


CScreenMap::SetSystemKeyCapsLock

x;

Parameters

Return Value

Returns

Remarks


CScreenMap::SetSystemKeyCtrl

x;

Parameters

Return Value

Returns

Remarks


CScreenMap::SetSystemKeyShift

x;

Parameters

Return Value

Returns

Remarks


CScreenMap::TimerAsynchronousUpdate

x;

Parameters

Return Value

Returns

Remarks


CScreenMap::TimerSynchronousUpdate

x;

Parameters

Return Value

Returns

Remarks


CScreenMap::ToggleDisplayExploredMap

x;

Parameters

Return Value

Returns

Remarks


CScreenMap::UpdateMainPanel

x;

Parameters

Return Value

Returns

Remarks


CScreenMap::WorldToMap

x;

Parameters

Return Value

Returns

Remarks