CScreenWorldMap Class

Overview
Quick Reference
Constructors
Methods

Overview

Note

The CScreenWorldMap class handles the world map and interaction with it

The structure used for this class is CScreenWorldMap

Quick Reference

Quick Ref

void CScreenWorldMap::CScreenWorldMap()

virtual void CScreenWorldMap::~CScreenWorldMap()

unsigned long CScreenWorldMap::CalculateTravelTime(unsigned long nArea)

virtual void CScreenWorldMap::CancelEngine()

void CScreenWorldMap::CenterMarker()

virtual int CScreenWorldMap::CheckMouseLButton()

virtual int CScreenWorldMap::CheckMouseMove()

virtual int CScreenWorldMap::CheckMouseRButton()

virtual int CScreenWorldMap::CheckMouseWheel()

virtual int CScreenWorldMap::CheckSystemKeyCapsLock()

virtual int CScreenWorldMap::CheckSystemKeyCtrl()

virtual int CScreenWorldMap::CheckSystemKeyShift()

void CScreenWorldMap::ClearChatMessages()

int CScreenWorldMap::DrawMap(CRect& r)

virtual void CScreenWorldMap::EngineActivated()

virtual void CScreenWorldMap::EngineDeactivated()

virtual void CScreenWorldMap::EngineDestroyed()

virtual void CScreenWorldMap::EngineGameInit()

virtual void CScreenWorldMap::EngineGameUninit()

virtual void CScreenWorldMap::EngineInitialized()

void CScreenWorldMap::EnterArea(CResRef& cResArea, CString sEntryPoint, short nFacing, int bEncounter, unsigned long nTravelTime)

unsigned long CScreenWorldMap::FindAreaHit(CPoint& ptMousePos)

CRect CScreenWorldMap::GetAreaRect(unsigned long nMap, unsigned long nArea)

virtual int CScreenWorldMap::GetCapsLockKey()

virtual void CScreenWorldMap::GetChatEditBoxStatus(CString& sChatText, int& bInputCapture)

virtual int CScreenWorldMap::GetCtrlKey()

virtual int CScreenWorldMap::GetEngineState()

unsigned short CScreenWorldMap::GetHighlightFrame()

unsigned char CScreenWorldMap::GetIsMapActive()

void CScreenWorldMap::GetMarkerPosition(CPoint& ptMarker)

virtual short CScreenWorldMap::GetNumVirtualKeys()

virtual int CScreenWorldMap::GetShiftKey()

virtual CKeyInfo* CScreenWorldMap::GetVirtualKeys()

virtual int* CScreenWorldMap::GetVirtualKeysFlags()

int CScreenWorldMap::IsForcedRandomEncounterActive(CString sAreaName)

void CScreenWorldMap::OnAreaMouseClick(unsigned long nArea)

void CScreenWorldMap::OnCancelButtonClick()

void CScreenWorldMap::OnDoneButtonClick()

virtual void CScreenWorldMap::OnKeyDown(int nKeysFlags)

virtual void CScreenWorldMap::OnKeyUp(int nKeysFlags)

virtual void CScreenWorldMap::OnLButtonDblClk(CPoint cPoint)

virtual void CScreenWorldMap::OnLButtonDown(CPoint cPoint)

virtual void CScreenWorldMap::OnLButtonUp(CPoint cPoint)

void CScreenWorldMap::OnMapMouseDown(int x, int y)

void CScreenWorldMap::OnMapMouseMove(int x, int y)

virtual void CScreenWorldMap::OnMouseMove(CPoint cPoint)

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

virtual void CScreenWorldMap::OnRButtonDown(CPoint cPoint)

virtual void CScreenWorldMap::OnRButtonUp(CPoint cPoint)

void CScreenWorldMap::SetAreaPalette(unsigned long wAreaForeground, int bColorOverride)

virtual void CScreenWorldMap::SetChatEditBoxStatus(CString& sChatText, int bInputCapture)

void CScreenWorldMap::SetMapView(CPoint& ptMapView)

virtual void CScreenWorldMap::SetSystemKeyCapsLock(int bValue)

virtual void CScreenWorldMap::SetSystemKeyCtrl(unsigned char bValue)

virtual void CScreenWorldMap::SetSystemKeyShift(int bValue)

void CScreenWorldMap::StartWorldMap(int nEngineState, long nLeavingEdge, unsigned char bInControl)

void CScreenWorldMap::StopWorldMap(unsigned char bAreaClicked)

virtual void CScreenWorldMap::TimerAsynchronousUpdate()

virtual void CScreenWorldMap::TimerSynchronousUpdate()

void CScreenWorldMap::TravelToSelected()

void CScreenWorldMap::UpdateMainPanel()

Constructors

Name	Description
CScreenWorldMap::CScreenWorldMap	Constructs a `CScreenWorldMap` object
CScreenWorldMap::CScreenWorldMap	Destroys a `CScreenWorldMap` object

CScreenWorldMap::CScreenWorldMap

Constructs a CScreenWorldMap object

void CScreenWorldMap::CScreenWorldMap();

Remarks

Constructs a CScreenWorldMap object

CScreenWorldMap::~CScreenWorldMap

Destroys the CScreenWorldMap object

virtual void CScreenWorldMap::~CScreenWorldMap();

Remarks

Destroys the CScreenWorldMap object

Methods

Name	Description
CScreenWorldMap::CalculateTravelTime
CScreenWorldMap::CancelEngine
CScreenWorldMap::CenterMarker
CScreenWorldMap::CheckMouseLButton
CScreenWorldMap::CheckMouseMove
CScreenWorldMap::CheckMouseRButton
CScreenWorldMap::CheckMouseWheel
CScreenWorldMap::CheckSystemKeyCapsLock
CScreenWorldMap::CheckSystemKeyCtrl
CScreenWorldMap::CheckSystemKeyShift
CScreenWorldMap::ClearChatMessages
CScreenWorldMap::DrawMap
CScreenWorldMap::EngineActivated
CScreenWorldMap::EngineDeactivated
CScreenWorldMap::EngineDestroyed
CScreenWorldMap::EngineGameInit
CScreenWorldMap::EngineGameUninit
CScreenWorldMap::EngineInitialized
CScreenWorldMap::EnterArea
CScreenWorldMap::FindAreaHit
CScreenWorldMap::GetAreaRect
CScreenWorldMap::GetCapsLockKey
CScreenWorldMap::GetChatEditBoxStatus
CScreenWorldMap::GetCtrlKey
CScreenWorldMap::GetEngineState
CScreenWorldMap::GetHighlightFrame
CScreenWorldMap::GetIsMapActive
CScreenWorldMap::GetMarkerPosition
CScreenWorldMap::GetNumVirtualKeys
CScreenWorldMap::GetShiftKey
CScreenWorldMap::GetVirtualKeys
CScreenWorldMap::GetVirtualKeysFlags
CScreenWorldMap::IsForcedRandomEncounterActive
CScreenWorldMap::OnAreaMouseClick
CScreenWorldMap::OnCancelButtonClick
CScreenWorldMap::OnDoneButtonClick
CScreenWorldMap::OnKeyDown
CScreenWorldMap::OnKeyUp
CScreenWorldMap::OnLButtonDblClk
CScreenWorldMap::OnLButtonDown
CScreenWorldMap::OnLButtonUp
CScreenWorldMap::OnMapMouseDown
CScreenWorldMap::OnMapMouseMove
CScreenWorldMap::OnMouseMove
CScreenWorldMap::OnMouseWheel
CScreenWorldMap::OnRButtonDown
CScreenWorldMap::OnRButtonUp
CScreenWorldMap::SetAreaPalette
CScreenWorldMap::SetChatEditBoxStatus
CScreenWorldMap::SetMapView
CScreenWorldMap::SetSystemKeyCapsLock
CScreenWorldMap::SetSystemKeyCtrl
CScreenWorldMap::SetSystemKeyShift
CScreenWorldMap::StartWorldMap
CScreenWorldMap::StopWorldMap
CScreenWorldMap::TimerAsynchronousUpdate
CScreenWorldMap::TimerSynchronousUpdate
CScreenWorldMap::TravelToSelected
CScreenWorldMap::UpdateMainPanel

CScreenWorldMap::CalculateTravelTime

x;

Parameters

Return Value

Returns

Remarks

CScreenWorldMap::CancelEngine

x;

Parameters

Return Value

Returns

Remarks

CScreenWorldMap::CenterMarker

x;

Parameters

Return Value

Returns

Remarks

CScreenWorldMap::CheckMouseLButton

x;

Parameters

Return Value

Returns

Remarks

CScreenWorldMap::CheckMouseMove

x;

Parameters

Return Value

Returns

Remarks

CScreenWorldMap::CheckMouseRButton

x;

Parameters

Return Value

Returns

Remarks

CScreenWorldMap::CheckMouseWheel

x;

Parameters

Return Value

Returns

Remarks

CScreenWorldMap::CheckSystemKeyCapsLock

x;

Parameters

Return Value

Returns

Remarks

CScreenWorldMap::CheckSystemKeyCtrl

x;

Parameters

Return Value

Returns

Remarks

CScreenWorldMap::CheckSystemKeyShift

x;

Parameters

Return Value

Returns

Remarks

CScreenWorldMap::ClearChatMessages

x;

Parameters

Return Value

Returns

Remarks

CScreenWorldMap::DrawMap

x;

Parameters

Return Value

Returns

Remarks

CScreenWorldMap::EngineActivated

x;

Parameters

Return Value

Returns

Remarks

CScreenWorldMap::EngineDeactivated

x;

Parameters

Return Value

Returns

Remarks

CScreenWorldMap::EngineDestroyed

x;

Parameters

Return Value

Returns

Remarks

CScreenWorldMap::EngineGameInit

x;

Parameters

Return Value

Returns

Remarks

CScreenWorldMap::EngineGameUninit

x;

Parameters

Return Value

Returns

Remarks

CScreenWorldMap::EngineInitialized

x;

Parameters

Return Value

Returns

Remarks

CScreenWorldMap::EnterArea

x;

Parameters

Return Value

Returns

Remarks

CScreenWorldMap::FindAreaHit

x;

Parameters

Return Value

Returns

Remarks

CScreenWorldMap::GetAreaRect

x;

Parameters

Return Value

Returns

Remarks

CScreenWorldMap::GetCapsLockKey

x;

Parameters

Return Value

Returns

Remarks

CScreenWorldMap::GetChatEditBoxStatus

x;

Parameters

Return Value

Returns

Remarks

CScreenWorldMap::GetCtrlKey

x;

Parameters

Return Value

Returns

Remarks

CScreenWorldMap::GetEngineState

x;

Parameters

Return Value

Returns

Remarks

CScreenWorldMap::GetHighlightFrame

x;

Parameters

Return Value

Returns

Remarks

CScreenWorldMap::GetIsMapActive

x;

Parameters

Return Value

Returns

Remarks

CScreenWorldMap::GetMarkerPosition

x;

Parameters

Return Value

Returns

Remarks

CScreenWorldMap::GetNumVirtualKeys

x;

Parameters

Return Value

Returns

Remarks

CScreenWorldMap::GetShiftKey

x;

Parameters

Return Value

Returns

Remarks

CScreenWorldMap::GetVirtualKeys

x;

Parameters

Return Value

Returns

Remarks

CScreenWorldMap::GetVirtualKeysFlags

x;

Parameters

Return Value

Returns

Remarks

CScreenWorldMap::IsForcedRandomEncounterActive

x;

Parameters

Return Value

Returns

Remarks

CScreenWorldMap::OnAreaMouseClick

x;

Parameters

Return Value

Returns

Remarks

CScreenWorldMap::OnCancelButtonClick

x;

Parameters

Return Value

Returns

Remarks

CScreenWorldMap::OnDoneButtonClick

x;

Parameters

Return Value

Returns

Remarks

CScreenWorldMap::OnKeyDown

x;

Parameters

Return Value

Returns

Remarks

CScreenWorldMap::OnKeyUp

x;

Parameters

Return Value

Returns

Remarks

CScreenWorldMap::OnLButtonDblClk

x;

Parameters

Return Value

Returns

Remarks

CScreenWorldMap::OnLButtonDown

x;

Parameters

Return Value

Returns

Remarks

CScreenWorldMap::OnLButtonUp

x;

Parameters

Return Value

Returns

Remarks

CScreenWorldMap::OnMapMouseDown

x;

Parameters

Return Value

Returns

Remarks

CScreenWorldMap::OnMapMouseMove

x;

Parameters

Return Value

Returns

Remarks

CScreenWorldMap::OnMouseMove

x;

Parameters

Return Value

Returns

Remarks

CScreenWorldMap::OnMouseWheel

x;

Parameters

Return Value

Returns

Remarks

CScreenWorldMap::OnRButtonDown

x;

Parameters

Return Value

Returns

Remarks

CScreenWorldMap::OnRButtonUp

x;

Parameters

Return Value

Returns

Remarks

CScreenWorldMap::SetAreaPalette

x;

Parameters

Return Value

Returns

Remarks

CScreenWorldMap::SetChatEditBoxStatus

x;

Parameters

Return Value

Returns

Remarks

CScreenWorldMap::SetMapView

x;

Parameters

Return Value

Returns

Remarks

CScreenWorldMap::SetSystemKeyCapsLock

x;

Parameters

Return Value

Returns

Remarks

CScreenWorldMap::SetSystemKeyCtrl

x;

Parameters

Return Value

Returns

Remarks

CScreenWorldMap::SetSystemKeyShift

x;

Parameters

Return Value

Returns

Remarks

CScreenWorldMap::StartWorldMap

x;

Parameters

Return Value

Returns

Remarks

CScreenWorldMap::StopWorldMap

x;

Parameters

Return Value

Returns

Remarks

CScreenWorldMap::TimerAsynchronousUpdate

x;

Parameters

Return Value

Returns

Remarks

CScreenWorldMap::TimerSynchronousUpdate

x;

Parameters

Return Value

Returns

Remarks

CScreenWorldMap::TravelToSelected

x;

Parameters

Return Value

Returns

Remarks

CScreenWorldMap::UpdateMainPanel

x;

Parameters

Return Value

Returns

Remarks