CScreenWorld Class¶
Overview¶
Note
The CScreenWorld class handles initial game world interactions and events before handing off to more specialized classes
The structure used for this class is CScreenWorld
Quick Reference¶
Quick Ref |
void CScreenWorld::CScreenWorld() |
virtual void CScreenWorld::~CScreenWorld() |
void CScreenWorld::ActivateDialogMenu() |
void CScreenWorld::AddGold(unsigned long dwGold) |
void CScreenWorld::AddTalker(long index) |
void CScreenWorld::AsynchronousUpdate(int bActiveEngine) |
virtual void CScreenWorld::CancelEngine() |
void CScreenWorld::Cheat_GiveAllSpells() |
void CScreenWorld::CheckAutomatedSpeedOptions() |
void CScreenWorld::CheckEndOfHardPause() |
virtual int CScreenWorld::CheckMouseLButton() |
virtual int CScreenWorld::CheckMouseMButton() |
virtual int CScreenWorld::CheckMouseMove() |
virtual int CScreenWorld::CheckMouseRButton() |
virtual int CScreenWorld::CheckMouseWheel() |
int CScreenWorld::CheckPartyValidity() |
virtual int CScreenWorld::CheckSystemKeyCapsLock() |
virtual int CScreenWorld::CheckSystemKeyCtrl() |
virtual int CScreenWorld::CheckSystemKeyShift() |
void CScreenWorld::ClearChatMessages() |
void CScreenWorld::ClearMenus() |
int CScreenWorld::ContainerScrollEnabled(int direction) |
void CScreenWorld::CreateEngine(int nEngine) |
void CScreenWorld::DeleteArea(CGameArea* pArea) |
void CScreenWorld::DeleteAreaMultiplayer() |
virtual void CScreenWorld::DisableEditKeys() |
void CScreenWorld::DisableKeyRepeat() |
void CScreenWorld::DisplayChatMessage(CString text) |
POSITION* CScreenWorld::DisplayText(CString& sSender, CString& sText, long nMarker, int moveToTop) |
POSITION* CScreenWorld::DisplayText(CString& sSender, CString& sText, unsigned long nameColor, unsigned long textColor, long nMarker, int makeTop, unsigned long nDialogIndent, int appendToDialog) |
virtual void CScreenWorld::EnableEditKeys(short typeFormat) |
void CScreenWorld::EnableKeyRepeat() |
void CScreenWorld::EndDialog(unsigned char bForceExecution, unsigned char fullEnd) |
virtual void CScreenWorld::EngineActivated() |
virtual void CScreenWorld::EngineDeactivated() |
virtual void CScreenWorld::EngineDestroyed() |
virtual void CScreenWorld::EngineInitialized() |
virtual void CScreenWorld::EngineGameInit() |
virtual void CScreenWorld::EngineGameUninit() |
virtual int CScreenWorld::GetCapsLockKey() |
virtual int CScreenWorld::GetCtrlKey() |
CString CScreenWorld::GetCurrentTimeString() |
CRect CScreenWorld::GetNewViewSize() |
virtual short CScreenWorld::GetNumVirtualKeys() |
long CScreenWorld::GetPickPartyCharacterId(int nPortrait) |
const char* CScreenWorld::GetPickPartyPortrait(int nPortrait) |
virtual int CScreenWorld::GetSelectedCharacter() |
virtual int CScreenWorld::GetShiftKey() |
int CScreenWorld::GetStateOverride() |
int CScreenWorld::GetTopGroundItem() |
virtual CKeyInfo* CScreenWorld::GetVirtualKeys() |
virtual int* CScreenWorld::GetVirtualKeysFlags() |
int CScreenWorld::GroundScrollEnabled(int direction) |
int CScreenWorld::GroupScrollEnabled(int direction) |
void CScreenWorld::HandleAmbiance() |
void CScreenWorld::HandleDeathReaction() |
void CScreenWorld::HandleInteraction() |
void CScreenWorld::HideInterface() |
int CScreenWorld::HighlightEnabled() |
int CScreenWorld::InteractionBlocked() |
int CScreenWorld::IsPauseInWait() |
int CScreenWorld::IsPickPartyDoneButtonClickable() |
int CScreenWorld::IsPickPartyRemoveButtonClickable() |
bool CScreenWorld::IsUIClear() |
void CScreenWorld::LeaveAreaLuaPanic(CPoint ptLocation, short nDirection, CString sAreaName, CString sParchment) |
void CScreenWorld::MoveToArea(CString areaName) |
void CScreenWorld::OnContainerButtonClick(unsigned long dwButtonId) |
void CScreenWorld::OnContainerScroll(int direction) |
void CScreenWorld::OnDeathLoad() |
void CScreenWorld::OnDeathQuit() |
void CScreenWorld::OnDialogReplyClick(int index) |
virtual bool CScreenWorld::OnEvent(SDL_Event* e) |
void CScreenWorld::OnGroundButtonClick(int nSlot, long nContainer, const char* res) |
void CScreenWorld::OnGroundScroll(int direction) |
void CScreenWorld::OnGroupScroll(int direction) |
void CScreenWorld::OnHelpButtonClick() |
virtual void CScreenWorld::OnKeyDown(int nKeysFlags) |
virtual void CScreenWorld::OnKeyUp(int nKeysFlags) |
virtual void CScreenWorld::OnLButtonDblClk(CPoint cPoint) |
virtual void CScreenWorld::OnLButtonDown(CPoint cPoint) |
virtual void CScreenWorld::OnLButtonUp(CPoint cPoint) |
virtual void CScreenWorld::OnMButtonDown(CPoint cPoint) |
virtual void CScreenWorld::OnMButtonUp(CPoint cPoint) |
virtual void CScreenWorld::OnMouseMove(CPoint cPoint) |
virtual void CScreenWorld::OnMouseWheel(int bForward, long nTicks, unsigned long nLines, unsigned short wFlags) |
void CScreenWorld::OnPickPartyDoneButtonClick() |
void CScreenWorld::OnPickPartyPortraitButtonClick(int nPortrait) |
virtual void CScreenWorld::OnPortraitLClick(unsigned long id) |
void CScreenWorld::OnQuickSaveButtonClick(int bExportSave) |
virtual void CScreenWorld::OnRButtonDblClk(CPoint cPoint) |
virtual void CScreenWorld::OnRButtonDown(CPoint cPoint) |
virtual void CScreenWorld::OnRButtonUp(CPoint cPoint) |
virtual void CScreenWorld::OnRestButtonClick() |
void CScreenWorld::OnSelectionButtonClick() |
unsigned char CScreenWorld::ReadyEndCredits(unsigned char bForcedFromServer) |
unsigned char CScreenWorld::ReadyMovie(CResRef& res, unsigned char bForcedFromServer, unsigned char bDelay) |
void CScreenWorld::RemoveCharacterFromParty() |
void CScreenWorld::RemovePickPartyCharacterId(long nCharacterId) |
void CScreenWorld::RenderFrameTimes() |
void CScreenWorld::ResetDialogStates(long ignore) |
void CScreenWorld::ResetPickParty() |
void CScreenWorld::ResetZoom() |
void CScreenWorld::SaveScreen(CGameArea* pArea) |
void CScreenWorld::SetCurrentXP(unsigned long dwCurrentXP) |
void CScreenWorld::SetDialogPortrait(CResRef& resRef, int indexCurrentDialog) |
void CScreenWorld::SetDialogTokens(CGameSprite* pCharacter) |
void CScreenWorld::SetHighlightEnabled(int enable) |
void CScreenWorld::SetLeaveAreaLuaPanicData(CPoint ptValue, short nValue, CString sValue1, CString sValue2) |
void CScreenWorld::SetPendingChapterChange(unsigned char nChapter, unsigned char* szChapterResRef) |
void CScreenWorld::SetPendingMapWorld(int idController, short facingDirection) |
void CScreenWorld::SetPendingMovie(unsigned char* szMovieResRef) |
void CScreenWorld::SetPendingReformParty() |
void CScreenWorld::SetPendingRest(int nHP, unsigned char bRenting, unsigned char bMovie, int nGP) |
void CScreenWorld::SetPendingTextScreenChange(unsigned char* szTextScreenResRef) |
virtual void CScreenWorld::SetSystemKeyCapsLock(int bValue) |
virtual void CScreenWorld::SetSystemKeyCtrl(unsigned char bValue) |
virtual void CScreenWorld::SetSystemKeyShift(int bValue) |
void CScreenWorld::StartCommand() |
void CScreenWorld::StartContainer() |
void CScreenWorld::StartDeath() |
void CScreenWorld::StartDeathReaction(CString& sName) |
int CScreenWorld::StartDialog(CGameSprite* pCharacter, CGameSprite* pNPC, unsigned char checkHostility, unsigned char interaction, CString& diaOverride, int bSuppressName, int bItemDialog) |
void CScreenWorld::StartGroundItems() |
void CScreenWorld::StartMapWorldMultiplayerHost(int idController, short facingDirection) |
void CScreenWorld::StartMovieMultiplayerHost(unsigned char* cMovieResRef) |
void CScreenWorld::StartPickParty(int firstCall) |
void CScreenWorld::StartReformPartyMultiplayerHost() |
void CScreenWorld::StartRestMultiplayerHost(int nHP, unsigned char bRenting, unsigned char bMovie, int nGP) |
void CScreenWorld::StartSaveGameMultiplayerHost() |
void CScreenWorld::StartScroll(CPoint dest, short speed) |
void CScreenWorld::StartStore(CAIObjectType& cAIProprietor, CAIObjectType& cAICustomer, CResRef cResStore, unsigned char bInitiate, unsigned char bCheckRestrict, unsigned char bCheckPermission) |
void CScreenWorld::StepDialog() |
void CScreenWorld::StopCommand() |
void CScreenWorld::StopContainer() |
void CScreenWorld::StopGroundItems() |
void CScreenWorld::StopPickParty() |
void CScreenWorld::StopStore() |
void CScreenWorld::StoreGroup() |
void CScreenWorld::SwapPortraits(int nID1, int nID2) |
void CScreenWorld::TakeAllFromContainer() |
virtual void CScreenWorld::TimerAsynchronousUpdate() |
virtual void CScreenWorld::TimerSynchronousUpdate() |
int CScreenWorld::TogglePauseGame(unsigned char visualPause, unsigned char bSendMessage, int idPlayerPause, unsigned char bLogPause, unsigned char bRequireHostUnpause) |
void CScreenWorld::UnhideInterface() |
virtual void CScreenWorld::UpdateContainerStatus(long nContainerId, short nSlotNum) |
void CScreenWorld::UpdateLua() |
virtual void CScreenWorld::UpdatePartyGoldStatus() |
virtual void CScreenWorld::WindowResized(int w, int h) |
void CScreenWorld::ZoomToMap(bool bOverwriteOriginal) |
Constructors¶
Name |
Description |
Constructs a |
|
Destroys a |
CScreenWorld::CScreenWorld¶
Constructs a CScreenWorld object
void CScreenWorld::CScreenWorld();
Remarks
Constructs a CScreenWorld object
CScreenWorld::~CScreenWorld¶
Destroys the CScreenWorld object
virtual void CScreenWorld::~CScreenWorld();
Remarks
Destroys the CScreenWorld object
Methods¶
Name |
Description |
CScreenWorld::AddGold¶
x;
Parameters
Return Value
Returns
Remarks
CScreenWorld::AddTalker¶
x;
Parameters
Return Value
Returns
Remarks
CScreenWorld::AsynchronousUpdate¶
x;
Parameters
Return Value
Returns
Remarks
CScreenWorld::CancelEngine¶
x;
Parameters
Return Value
Returns
Remarks
CScreenWorld::Cheat_GiveAllSpells¶
x;
Parameters
Return Value
Returns
Remarks
CScreenWorld::CheckAutomatedSpeedOptions¶
x;
Parameters
Return Value
Returns
Remarks
CScreenWorld::CheckEndOfHardPause¶
x;
Parameters
Return Value
Returns
Remarks
CScreenWorld::CheckMouseMove¶
x;
Parameters
Return Value
Returns
Remarks
CScreenWorld::CheckMouseWheel¶
x;
Parameters
Return Value
Returns
Remarks
CScreenWorld::CheckPartyValidity¶
x;
Parameters
Return Value
Returns
Remarks
CScreenWorld::CheckSystemKeyCapsLock¶
x;
Parameters
Return Value
Returns
Remarks
CScreenWorld::CheckSystemKeyCtrl¶
x;
Parameters
Return Value
Returns
Remarks
CScreenWorld::CheckSystemKeyShift¶
x;
Parameters
Return Value
Returns
Remarks
CScreenWorld::ClearChatMessages¶
x;
Parameters
Return Value
Returns
Remarks
CScreenWorld::ContainerScrollEnabled¶
x;
Parameters
Return Value
Returns
Remarks
CScreenWorld::CreateEngine¶
x;
Parameters
Return Value
Returns
Remarks
CScreenWorld::DeleteArea¶
x;
Parameters
Return Value
Returns
Remarks
CScreenWorld::DeleteAreaMultiplayer¶
x;
Parameters
Return Value
Returns
Remarks
CScreenWorld::DisableEditKeys¶
x;
Parameters
Return Value
Returns
Remarks
CScreenWorld::DisableKeyRepeat¶
x;
Parameters
Return Value
Returns
Remarks
CScreenWorld::DisplayChatMessage¶
x;
Parameters
Return Value
Returns
Remarks
CScreenWorld::DisplayText¶
x;
Parameters
Return Value
Returns
Remarks
CScreenWorld::DisplayText¶
x;
Parameters
Return Value
Returns
Remarks
CScreenWorld::EnableEditKeys¶
x;
Parameters
Return Value
Returns
Remarks
CScreenWorld::EnableKeyRepeat¶
x;
Parameters
Return Value
Returns
Remarks
CScreenWorld::EndDialog¶
x;
Parameters
Return Value
Returns
Remarks
CScreenWorld::EngineActivated¶
x;
Parameters
Return Value
Returns
Remarks
CScreenWorld::EngineDeactivated¶
x;
Parameters
Return Value
Returns
Remarks
CScreenWorld::EngineDestroyed¶
x;
Parameters
Return Value
Returns
Remarks
CScreenWorld::EngineInitialized¶
x;
Parameters
Return Value
Returns
Remarks
CScreenWorld::EngineGameInit¶
x;
Parameters
Return Value
Returns
Remarks
CScreenWorld::EngineGameUninit¶
x;
Parameters
Return Value
Returns
Remarks
CScreenWorld::GetCapsLockKey¶
x;
Parameters
Return Value
Returns
Remarks
CScreenWorld::GetCtrlKey¶
x;
Parameters
Return Value
Returns
Remarks
CScreenWorld::GetCurrentTimeString¶
x;
Parameters
Return Value
Returns
Remarks
CScreenWorld::GetNewViewSize¶
x;
Parameters
Return Value
Returns
Remarks
CScreenWorld::GetNumVirtualKeys¶
x;
Parameters
Return Value
Returns
Remarks
CScreenWorld::GetPickPartyCharacterId¶
x;
Parameters
Return Value
Returns
Remarks
CScreenWorld::GetPickPartyPortrait¶
x;
Parameters
Return Value
Returns
Remarks
CScreenWorld::GetSelectedCharacter¶
x;
Parameters
Return Value
Returns
Remarks
CScreenWorld::GetShiftKey¶
x;
Parameters
Return Value
Returns
Remarks
CScreenWorld::GetStateOverride¶
x;
Parameters
Return Value
Returns
Remarks
CScreenWorld::GetTopGroundItem¶
x;
Parameters
Return Value
Returns
Remarks
CScreenWorld::GetVirtualKeys¶
x;
Parameters
Return Value
Returns
Remarks
CScreenWorld::GetVirtualKeysFlags¶
x;
Parameters
Return Value
Returns
Remarks
CScreenWorld::GroundScrollEnabled¶
x;
Parameters
Return Value
Returns
Remarks
CScreenWorld::GroupScrollEnabled¶
x;
Parameters
Return Value
Returns
Remarks
CScreenWorld::HandleAmbiance¶
x;
Parameters
Return Value
Returns
Remarks
CScreenWorld::HandleDeathReaction¶
x;
Parameters
Return Value
Returns
Remarks
CScreenWorld::HandleInteraction¶
x;
Parameters
Return Value
Returns
Remarks
CScreenWorld::HideInterface¶
x;
Parameters
Return Value
Returns
Remarks
CScreenWorld::HighlightEnabled¶
x;
Parameters
Return Value
Returns
Remarks
CScreenWorld::InteractionBlocked¶
x;
Parameters
Return Value
Returns
Remarks
CScreenWorld::IsPauseInWait¶
x;
Parameters
Return Value
Returns
Remarks
CScreenWorld::IsUIClear¶
x;
Parameters
Return Value
Returns
Remarks
CScreenWorld::LeaveAreaLuaPanic¶
x;
Parameters
Return Value
Returns
Remarks
CScreenWorld::MoveToArea¶
x;
Parameters
Return Value
Returns
Remarks
CScreenWorld::OnContainerScroll¶
x;
Parameters
Return Value
Returns
Remarks
CScreenWorld::OnDeathLoad¶
x;
Parameters
Return Value
Returns
Remarks
CScreenWorld::OnDeathQuit¶
x;
Parameters
Return Value
Returns
Remarks
CScreenWorld::OnDialogReplyClick¶
x;
Parameters
Return Value
Returns
Remarks
CScreenWorld::OnEvent¶
x;
Parameters
Return Value
Returns
Remarks
CScreenWorld::OnGroundScroll¶
x;
Parameters
Return Value
Returns
Remarks
CScreenWorld::OnGroupScroll¶
x;
Parameters
Return Value
Returns
Remarks
CScreenWorld::OnKeyDown¶
x;
Parameters
Return Value
Returns
Remarks
CScreenWorld::OnKeyUp¶
x;
Parameters
Return Value
Returns
Remarks
CScreenWorld::OnMouseMove¶
x;
Parameters
Return Value
Returns
Remarks
CScreenWorld::OnMouseWheel¶
x;
Parameters
Return Value
Returns
Remarks
CScreenWorld::OnPortraitLClick¶
x;
Parameters
Return Value
Returns
Remarks
CScreenWorld::ReadyEndCredits¶
x;
Parameters
Return Value
Returns
Remarks
CScreenWorld::ReadyMovie¶
x;
Parameters
Return Value
Returns
Remarks
CScreenWorld::RemoveCharacterFromParty¶
x;
Parameters
Return Value
Returns
Remarks
CScreenWorld::RemovePickPartyCharacterId¶
x;
Parameters
Return Value
Returns
Remarks
CScreenWorld::RenderFrameTimes¶
x;
Parameters
Return Value
Returns
Remarks
CScreenWorld::ResetDialogStates¶
x;
Parameters
Return Value
Returns
Remarks
CScreenWorld::ResetPickParty¶
x;
Parameters
Return Value
Returns
Remarks
CScreenWorld::ResetZoom¶
x;
Parameters
Return Value
Returns
Remarks
CScreenWorld::SaveScreen¶
x;
Parameters
Return Value
Returns
Remarks
CScreenWorld::SetCurrentXP¶
x;
Parameters
Return Value
Returns
Remarks
CScreenWorld::SetDialogPortrait¶
x;
Parameters
Return Value
Returns
Remarks
CScreenWorld::SetDialogTokens¶
x;
Parameters
Return Value
Returns
Remarks
CScreenWorld::SetHighlightEnabled¶
x;
Parameters
Return Value
Returns
Remarks
CScreenWorld::SetLeaveAreaLuaPanicData¶
x;
Parameters
Return Value
Returns
Remarks
CScreenWorld::SetPendingChapterChange¶
x;
Parameters
Return Value
Returns
Remarks
CScreenWorld::SetPendingMapWorld¶
x;
Parameters
Return Value
Returns
Remarks
CScreenWorld::SetPendingMovie¶
x;
Parameters
Return Value
Returns
Remarks
CScreenWorld::SetPendingReformParty¶
x;
Parameters
Return Value
Returns
Remarks
CScreenWorld::SetPendingRest¶
x;
Parameters
Return Value
Returns
Remarks
CScreenWorld::SetPendingTextScreenChange¶
x;
Parameters
Return Value
Returns
Remarks
CScreenWorld::SetSystemKeyCapsLock¶
x;
Parameters
Return Value
Returns
Remarks
CScreenWorld::SetSystemKeyCtrl¶
x;
Parameters
Return Value
Returns
Remarks
CScreenWorld::SetSystemKeyShift¶
x;
Parameters
Return Value
Returns
Remarks
CScreenWorld::StartCommand¶
x;
Parameters
Return Value
Returns
Remarks
CScreenWorld::StartContainer¶
x;
Parameters
Return Value
Returns
Remarks
CScreenWorld::StartDeath¶
x;
Parameters
Return Value
Returns
Remarks
CScreenWorld::StartDeathReaction¶
x;
Parameters
Return Value
Returns
Remarks
CScreenWorld::StartDialog¶
x;
Parameters
Return Value
Returns
Remarks
CScreenWorld::StartGroundItems¶
x;
Parameters
Return Value
Returns
Remarks
CScreenWorld::StartMapWorldMultiplayerHost¶
x;
Parameters
Return Value
Returns
Remarks
CScreenWorld::StartMovieMultiplayerHost¶
x;
Parameters
Return Value
Returns
Remarks
CScreenWorld::StartPickParty¶
x;
Parameters
Return Value
Returns
Remarks
CScreenWorld::StartReformPartyMultiplayerHost¶
x;
Parameters
Return Value
Returns
Remarks
CScreenWorld::StartRestMultiplayerHost¶
x;
Parameters
Return Value
Returns
Remarks
CScreenWorld::StartSaveGameMultiplayerHost¶
x;
Parameters
Return Value
Returns
Remarks
CScreenWorld::StartScroll¶
x;
Parameters
Return Value
Returns
Remarks
CScreenWorld::StartStore¶
x;
Parameters
Return Value
Returns
Remarks
CScreenWorld::StepDialog¶
x;
Parameters
Return Value
Returns
Remarks
CScreenWorld::StopCommand¶
x;
Parameters
Return Value
Returns
Remarks
CScreenWorld::StopContainer¶
x;
Parameters
Return Value
Returns
Remarks
CScreenWorld::StopGroundItems¶
x;
Parameters
Return Value
Returns
Remarks
CScreenWorld::StopPickParty¶
x;
Parameters
Return Value
Returns
Remarks
CScreenWorld::StopStore¶
x;
Parameters
Return Value
Returns
Remarks
CScreenWorld::StoreGroup¶
x;
Parameters
Return Value
Returns
Remarks
CScreenWorld::SwapPortraits¶
x;
Parameters
Return Value
Returns
Remarks
CScreenWorld::TakeAllFromContainer¶
x;
Parameters
Return Value
Returns
Remarks
CScreenWorld::TimerAsynchronousUpdate¶
x;
Parameters
Return Value
Returns
Remarks
CScreenWorld::TimerSynchronousUpdate¶
x;
Parameters
Return Value
Returns
Remarks
CScreenWorld::TogglePauseGame¶
x;
Parameters
Return Value
Returns
Remarks
CScreenWorld::UnhideInterface¶
x;
Parameters
Return Value
Returns
Remarks
CScreenWorld::UpdateContainerStatus¶
x;
Parameters
Return Value
Returns
Remarks
CScreenWorld::UpdateLua¶
x;
Parameters
Return Value
Returns
Remarks
CScreenWorld::UpdatePartyGoldStatus¶
x;
Parameters
Return Value
Returns
Remarks
CScreenWorld::WindowResized¶
x;
Parameters
Return Value
Returns
Remarks
CScreenWorld::ZoomToMap¶
x;
Parameters
Return Value
Returns
Remarks