CScreenStart Class¶
Overview¶
Note
The CScreenStart class handles the main title screen dialogs and buttons, including game options, game campaign, singleplayer, multiplayer, credits, etc
The structure used for this class is CScreenStart
Quick Reference¶
Quick Ref |
void CScreenStart::CScreenStart() |
virtual int CScreenStart::CheckMouseMove() |
void CScreenStart::ClearSaveGameName() |
void CScreenStart::DismissChooseCampaignPopup() |
virtual void CScreenStart::EngineActivated() |
virtual void CScreenStart::EngineDeactivated() |
virtual void CScreenStart::EngineDestroyed() |
virtual void CScreenStart::EngineInitialized() |
int CScreenStart::GetCampaign() |
CString CScreenStart::GetContinueSaveGameName() |
virtual int CScreenStart::GetEngineState() |
virtual short CScreenStart::GetNumVirtualKeys() |
virtual CKeyInfo* CScreenStart::GetVirtualKeys() |
virtual int* CScreenStart::GetVirtualKeysFlags() |
int CScreenStart::HasGameToContinue() |
void CScreenStart::OnCampaignButtonClick(char* campaign, bool playIntro) |
bool CScreenStart::OnContinueGame() |
void CScreenStart::OnCreatePartyButtonClick() |
void CScreenStart::OnDLCImageClick() |
void CScreenStart::OnImportCharacterButtonClick() |
virtual void CScreenStart::OnKeyDown(int nKeysFlags) |
void CScreenStart::OnLoadGameButtonClick() |
void CScreenStart::OnMultiPlayerButtonClick() |
void CScreenStart::OnNewGameButtonClick() |
void CScreenStart::OnOptionsButtonClick() |
void CScreenStart::OnPreGenerateButtonClick() |
void CScreenStart::OnPregenSelectButtonClick() |
void CScreenStart::OnQuitButtonClick() |
void CScreenStart::OnSoAButtonClick(bool playIntro) |
void CScreenStart::OnTBPButtonClick(bool playIntro) |
void CScreenStart::OnToBButtonClick(bool playIntro) |
void CScreenStart::OnTutorialButtonClick() |
void CScreenStart::ReadyEndCredits() |
virtual void CScreenStart::TimerAsynchronousUpdate() |
virtual void CScreenStart::TimerSynchronousUpdate() |
Constructors¶
Name |
Description |
Constructs a |
CScreenStart::CScreenStart¶
Constructs a CScreenStart
object
void CScreenStart::CScreenStart();
Remarks
Constructs a CScreenStart
object
Methods¶
Name |
Description |
Determines if mouse has moved |
|
Clear save game filename |
|
Closes choose campaign dialog |
|
Get the campaign |
|
Returns a string containing the save game filename |
|
Returns the engine state |
|
Determines if there is an existing game already saved, ready to be continued |
|
Event action for when campaign button is clicked |
|
Event action for when continue game button is clicked |
|
Event action for when create party button is clicked |
|
Event action for when a dlc button is clicked |
|
Event action for when import character button is clicked |
|
Key event for a key being pressed |
|
Event action for when load game button is clicked |
|
Event action for when multiplayer button is clicked |
|
Event action for when new game button is clicked |
|
Event action for when options button is clicked |
|
Event action for when pre-generate button is clicked |
|
Event action for when a selection button in the pre-generate is clicked |
|
Event action for when quit button is clicked |
|
Event action for when Shadows of Amn button is clicked |
|
Event action for when The Black Pits button is clicked |
|
Event action for when Throne of Bhaal button is clicked |
|
Event action for when tutorial button is clicked |
|
Event action for when credits button is clicked |
|
Update timer asynchronously |
|
Update timer synchronously |
CScreenStart::CheckMouseMove¶
Determines if mouse has moved
virtual int CScreenStart::CheckMouseMove();
Return Value
Returns int
Remarks
CScreenStart::ClearSaveGameName¶
Clear save game filename
void CScreenStart::ClearSaveGameName();
Remarks
CScreenStart::DismissChooseCampaignPopup¶
Closes choose campaign dialog
void CScreenStart::DismissChooseCampaignPopup();
Remarks
CScreenStart::EngineActivated¶
virtual void CScreenStart::EngineActivated();
Remarks
CScreenStart::EngineDeactivated¶
virtual void CScreenStart::EngineDeactivated();
Remarks
CScreenStart::EngineDestroyed¶
virtual void CScreenStart::EngineDestroyed();
Remarks
CScreenStart::EngineInitialized¶
virtual void CScreenStart::EngineInitialized();
Remarks
CScreenStart::GetCampaign¶
Get the campaign
int CScreenStart::GetCampaign();
Return Value
Returns an int
value representing campaign id
Remarks
CScreenStart::GetContinueSaveGameName¶
Returns a string containing the save game filename
CString CScreenStart::GetContinueSaveGameName();
Return Value
Returns a CString containing the save game
Remarks
See also CScreenStart::HasGameToContinue
CScreenStart::GetEngineState¶
Returns the engine state
virtual int CScreenStart::GetEngineState();
Return Value
Returns an int
value representing the engine state
Remarks
CScreenStart::GetNumVirtualKeys¶
virtual short CScreenStart::GetNumVirtualKeys();
Return Value
Returns a short
value
Remarks
CScreenStart::GetVirtualKeys¶
virtual CKeyInfo* CScreenStart::GetVirtualKeys();
Return Value
Returns CKeyInfo*
Remarks
CScreenStart::GetVirtualKeysFlags¶
virtual int* CScreenStart::GetVirtualKeysFlags();
Return Value
Returns int
*
Remarks
CScreenStart::HasGameToContinue¶
Determines if there is an existing game already saved, ready to be continued
int CScreenStart::HasGameToContinue() ;
Return Value
Returns an int
representing true 1
or false 0
Remarks
See also CScreenStart::GetContinueSaveGameName
CScreenStart::OnContinueGame¶
Event action for when continue game button is clicked
bool CScreenStart::OnContinueGame();
Return Value
Returns bool
- true 1
or false 0
Remarks
CScreenStart::OnDLCImageClick¶
Event action for when a dlc button is clicked
void CScreenStart::OnDLCImageClick();
Remarks
CScreenStart::OnKeyDown¶
Key event for a key being pressed
virtual void CScreenStart::OnKeyDown(int nKeysFlags);
Parameters
int
nKeysFlags - * *
Remarks
CScreenStart::ReadyEndCredits¶
Event action for when credits button is clicked
void CScreenStart::ReadyEndCredits();
Remarks
CScreenStart::TimerAsynchronousUpdate¶
Update timer asynchronously
virtual void CScreenStart::TimerAsynchronousUpdate();
Remarks
Processes a number of possible options: end credits to play based on 2DECRED.2DA
, show splash screen, game options dialog, campaign button, SoA button, ToB button, TBP button etc.
Calls the following functions: CScreenStart::OnSoAButtonClick, CScreenStart::OnTBPButtonClick and CScreenStart::OnCampaignButtonClick
CScreenStart::TimerSynchronousUpdate¶
Update timer synchronously
virtual void CScreenStart::TimerSynchronousUpdate();
Remarks