CScreenChapter Class¶
Overview¶
Note
The CScreenChapter class handles chapter screens and dream transitions
The structure used for this class is CScreenChapter
Quick Reference¶
Quick Ref |
void CScreenChapter::CScreenChapter() |
virtual void CScreenChapter::~CScreenChapter() |
virtual int CScreenChapter::CheckMouseLButton() |
virtual int CScreenChapter::CheckMouseMove() |
virtual int CScreenChapter::CheckMouseRButton() |
virtual int CScreenChapter::CheckSystemKeyCtrl() |
virtual void CScreenChapter::CancelEngine() |
virtual void CScreenChapter::EngineActivated() |
virtual void CScreenChapter::EngineDeactivated() |
virtual void CScreenChapter::EngineDestroyed() |
virtual void CScreenChapter::EngineGameInit() |
virtual void CScreenChapter::EngineInitialized() |
virtual void CScreenChapter::EngineGameUninit() |
virtual int CScreenChapter::GetEngineState() |
void CScreenChapter::GetNextDreamIndex(long& nDream) |
virtual short CScreenChapter::GetNumVirtualKeys() |
virtual int* CScreenChapter::GetVirtualKeysFlags() |
virtual CKeyInfo* CScreenChapter::GetVirtualKeys() |
int CScreenChapter::IsDoneButtonClickable() |
int CScreenChapter::IsReplayButtonClickable() |
void CScreenChapter::OnDoneButtonClick() |
virtual void CScreenChapter::OnKeyDown(int nKeysFlags) |
virtual void CScreenChapter::OnLButtonDown(CPoint cPoint) |
virtual void CScreenChapter::OnLButtonDblClk(CPoint cPoint) |
virtual void CScreenChapter::OnLButtonUp(CPoint cPoint) |
virtual void CScreenChapter::OnRButtonDown(CPoint cPoint) |
virtual void CScreenChapter::OnRButtonUp(CPoint cPoint) |
void CScreenChapter::OnMixerInitialize() |
virtual void CScreenChapter::OnMouseMove(CPoint cPoint) |
virtual void CScreenChapter::OnPortraitLClick(unsigned long id) |
void CScreenChapter::OnReplayButtonClick() |
void CScreenChapter::ResetMainPanel() |
virtual void CScreenChapter::SetSystemKeyCtrl(unsigned char bValue) |
void CScreenChapter::StartChapter(CResRef& cResText) |
void CScreenChapter::StartChapterMultiplayerHost(unsigned char nChapter, unsigned char* chapterResRef) |
int CScreenChapter::StartDream(unsigned char bRenting, CString& dreamOverride) |
int CScreenChapter::StartText(CResRef& cResText) |
void CScreenChapter::StartTextScreen(CString& textscreenOverride) |
void CScreenChapter::StartTextScreenMultiplayerHost(unsigned char* textscreenResRef) |
void CScreenChapter::StopDream() |
virtual int CScreenChapter::StopMusic() |
void CScreenChapter::StopText(int bNotifyServer) |
void CScreenChapter::StopTextScreen() |
void CScreenChapter::SwitchMainPanel(unsigned long dwMainPanelId) |
virtual void CScreenChapter::TimerAsynchronousUpdate() |
virtual void CScreenChapter::TimerSynchronousUpdate() |
Constructors¶
Name |
Description |
Constructs a |
|
Destroys a |
CScreenChapter::CScreenChapter¶
Constructs a CScreenChapter
object
void CScreenChapter::CScreenChapter();
Remarks
Constructs a CScreenChapter
object
CScreenChapter::~CScreenChapter¶
Destroys the CScreenChapter
object
virtual void CScreenChapter::~CScreenChapter();
Remarks
Destroys the CScreenChapter
object
Methods¶
Name |
Description |
CScreenChapter::CheckMouseMove¶
virtual int CScreenChapter::CheckMouseMove();
Return Value
int
Remarks
CScreenChapter::CheckSystemKeyCtrl¶
virtual int CScreenChapter::CheckSystemKeyCtrl();
Return Value
int
Remarks
CScreenChapter::CancelEngine¶
virtual void CScreenChapter::CancelEngine();
Remarks
CScreenChapter::EngineActivated¶
virtual void CScreenChapter::EngineActivated();
Remarks
CScreenChapter::EngineDeactivated¶
virtual void CScreenChapter::EngineDeactivated();
Remarks
CScreenChapter::EngineDestroyed¶
virtual void CScreenChapter::EngineDestroyed();
Remarks
CScreenChapter::EngineGameInit¶
virtual void CScreenChapter::EngineGameInit();
Remarks
CScreenChapter::EngineInitialized¶
virtual void CScreenChapter::EngineInitialized();
Remarks
CScreenChapter::EngineGameUninit¶
virtual void CScreenChapter::EngineGameUninit();
Remarks
CScreenChapter::GetEngineState¶
virtual int CScreenChapter::GetEngineState();
Return Value
int
Remarks
CScreenChapter::GetNextDreamIndex¶
void CScreenChapter::GetNextDreamIndex(long& nDream);
Parameters
long
& nDream -
Remarks
CScreenChapter::GetNumVirtualKeys¶
virtual short CScreenChapter::GetNumVirtualKeys();
Return Value
short
Remarks
CScreenChapter::GetVirtualKeysFlags¶
virtual int\* CScreenChapter::GetVirtualKeysFlags();
Return Value
int
*
Remarks
CScreenChapter::GetVirtualKeys¶
virtual :ref:`CKeyInfo<CKeyInfo>`\* CScreenChapter::GetVirtualKeys();
Return Value
Returns CKeyInfo*
Remarks
CScreenChapter::OnKeyDown¶
virtual void CScreenChapter::OnKeyDown(int nKeysFlags);
Parameters
int
nKeysFlags -
Remarks
CScreenChapter::OnMixerInitialize¶
void CScreenChapter::OnMixerInitialize();
Remarks
CScreenChapter::OnMouseMove¶
virtual void CScreenChapter::OnMouseMove(:ref:`CPoint<CPoint>` cPoint);
Parameters
CPoint cPoint -
Remarks
CScreenChapter::OnPortraitLClick¶
virtual void CScreenChapter::OnPortraitLClick(unsigned long id);
Parameters
unsigned long
id -
Remarks
CScreenChapter::ResetMainPanel¶
void CScreenChapter::ResetMainPanel();
Remarks
CScreenChapter::SetSystemKeyCtrl¶
virtual void CScreenChapter::SetSystemKeyCtrl(unsigned char bValue);
Parameters
unsigned char
bValue -
Remarks
CScreenChapter::StartChapter¶
void CScreenChapter::StartChapter(:ref:`CResRef<CResRef>`\& cResText);
Parameters
CResRef& cResText -
Remarks
CScreenChapter::StartChapterMultiplayerHost¶
void CScreenChapter::StartChapterMultiplayerHost(
unsigned char nChapter,
unsigned char* chapterResRef);
Parameters
unsigned char
nChapter -unsigned char
* chapterResRef -
Remarks
CScreenChapter::StartDream¶
int CScreenChapter::StartDream(
unsigned char bRenting,
CString& dreamOverride);
Parameters
unsigned char
bRenting -CString& dreamOverride -
Return Value
int
Remarks
CScreenChapter::StartText¶
int CScreenChapter::StartText(:ref:`CResRef<CResRef>`\& cResText);
Parameters
CResRef& cResText -
Return Value
int
Remarks
CScreenChapter::StartTextScreen¶
void CScreenChapter::StartTextScreen(:ref:`CString<CString>`\& textscreenOverride);
Parameters
CString& textscreenOverride -
Remarks
CScreenChapter::StartTextScreenMultiplayerHost¶
void CScreenChapter::StartTextScreenMultiplayerHost(unsigned char\* textscreenResRef);
Parameters
unsigned char* textscreenResRef -
Remarks
CScreenChapter::StopDream¶
void CScreenChapter::StopDream();
Remarks
CScreenChapter::StopMusic¶
virtual int CScreenChapter::StopMusic();
Return Value
int
Remarks
CScreenChapter::StopText¶
void CScreenChapter::StopText(int bNotifyServer);
Parameters
int
bNotifyServer -
Remarks
CScreenChapter::StopTextScreen¶
void CScreenChapter::StopTextScreen();
Remarks
CScreenChapter::SwitchMainPanel¶
void CScreenChapter::SwitchMainPanel(unsigned long dwMainPanelId);
Parameters
unsigned long
dwMainPanelId -
Remarks
CScreenChapter::TimerAsynchronousUpdate¶
virtual void CScreenChapter::TimerAsynchronousUpdate();
Remarks
CScreenChapter::TimerSynchronousUpdate¶
virtual void CScreenChapter::TimerSynchronousUpdate();
Remarks