CScreenStart Class

• Overview

• Quick Reference

• Constructors

• Methods

---

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
CScreenStart::CScreenStart	Constructs a CScreenStart object

CScreenStart::CScreenStart

Constructs a CScreenStart object

void CScreenStart::CScreenStart();

Remarks

Constructs a CScreenStart object

---

Methods

Name	Description
CScreenStart::CheckMouseMove	Determines if mouse has moved
CScreenStart::ClearSaveGameName	Clear save game filename
CScreenStart::DismissChooseCampaignPopup	Closes choose campaign dialog
CScreenStart::EngineActivated
CScreenStart::EngineDeactivated
CScreenStart::EngineDestroyed
CScreenStart::EngineInitialized
CScreenStart::GetCampaign	Get the campaign
CScreenStart::GetContinueSaveGameName	Returns a string containing the save game filename
CScreenStart::GetEngineState	Returns the engine state
CScreenStart::GetNumVirtualKeys
CScreenStart::GetVirtualKeys
CScreenStart::GetVirtualKeysFlags
CScreenStart::HasGameToContinue	Determines if there is an existing game already saved, ready to be continued
CScreenStart::OnCampaignButtonClick	Event action for when campaign button is clicked
CScreenStart::OnContinueGame	Event action for when continue game button is clicked
CScreenStart::OnCreatePartyButtonClick	Event action for when create party button is clicked
CScreenStart::OnDLCImageClick	Event action for when a dlc button is clicked
CScreenStart::OnImportCharacterButtonClick	Event action for when import character button is clicked
CScreenStart::OnKeyDown	Key event for a key being pressed
CScreenStart::OnLoadGameButtonClick	Event action for when load game button is clicked
CScreenStart::OnMultiPlayerButtonClick	Event action for when multiplayer button is clicked
CScreenStart::OnNewGameButtonClick	Event action for when new game button is clicked
CScreenStart::OnOptionsButtonClick	Event action for when options button is clicked
CScreenStart::OnPreGenerateButtonClick	Event action for when pre-generate button is clicked
CScreenStart::OnPregenSelectButtonClick	Event action for when a selection button in the pre-generate is clicked
CScreenStart::OnQuitButtonClick	Event action for when quit button is clicked
CScreenStart::OnSoAButtonClick	Event action for when Shadows of Amn button is clicked
CScreenStart::OnTBPButtonClick	Event action for when The Black Pits button is clicked
CScreenStart::OnToBButtonClick	Event action for when Throne of Bhaal button is clicked
CScreenStart::OnTutorialButtonClick	Event action for when tutorial button is clicked
CScreenStart::ReadyEndCredits	Event action for when credits button is clicked
CScreenStart::TimerAsynchronousUpdate	Update timer asynchronously
CScreenStart::TimerSynchronousUpdate	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::OnCampaignButtonClick

Event action for when campaign button is clicked

void CScreenStart::OnCampaignButtonClick(
   char* campaign,
   bool playIntro);

Parameters

• char* campaign - CAMPAIGN.2DA column label

• bool playIntro - play intro movie or not

Remarks

Optionally plays intro movie if playIntro parameter is true. Loads 2da file under the CAMPAIGN.2DA campaign column label.

Writes to Baldur.lua the active campaign id, the Active Campaign key value under the Program Options section.

CScreenStart::OnCampaignButtonClick is called from CScreenStart::TimerAsynchronousUpdate and tolua_BaldurLUA_CScreenStart_OnCampaignButtonClick00

---

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::OnCreatePartyButtonClick

Event action for when create party button is clicked

void CScreenStart::OnCreatePartyButtonClick();

Remarks

---

CScreenStart::OnDLCImageClick

Event action for when a dlc button is clicked

void CScreenStart::OnDLCImageClick();

Remarks

---

CScreenStart::OnImportCharacterButtonClick

Event action for when import character button is clicked

void CScreenStart::OnImportCharacterButtonClick();

Remarks

---

CScreenStart::OnKeyDown

Key event for a key being pressed

virtual void CScreenStart::OnKeyDown(int nKeysFlags);

Parameters

• int nKeysFlags - * *

Remarks

---

CScreenStart::OnLoadGameButtonClick

Event action for when load game button is clicked

void CScreenStart::OnLoadGameButtonClick();

Remarks

---

CScreenStart::OnMultiPlayerButtonClick

Event action for when multiplayer button is clicked

void CScreenStart::OnMultiPlayerButtonClick();

Remarks

---

CScreenStart::OnNewGameButtonClick

Event action for when new game button is clicked

void CScreenStart::OnNewGameButtonClick();

Remarks

---

CScreenStart::OnOptionsButtonClick

Event action for when options button is clicked

void CScreenStart::OnOptionsButtonClick();

Remarks

---

CScreenStart::OnPreGenerateButtonClick

Event action for when pre-generate button is clicked

void CScreenStart::OnPreGenerateButtonClick();

Remarks

Allows player to select pre-generated characters from a list in a dialog to play in the game

---

CScreenStart::OnPregenSelectButtonClick

Event action for when a selection button in the pre-generate is clicked

void CScreenStart::OnPregenSelectButtonClick();

Remarks

---

CScreenStart::OnQuitButtonClick

Event action for when quit button is clicked

void CScreenStart::OnQuitButtonClick();

Remarks

---

CScreenStart::OnSoAButtonClick

Event action for when Shadows of Amn button is clicked

void CScreenStart::OnSoAButtonClick(bool playIntro);

Parameters

• bool playIntro - play intro movie or not

Remarks

Optionally plays intro movie if playIntro parameter is true. Plays INTRO15F.WBM or INTRO.WBM movie.

Sets start area based on contents of STARTARE.2DA - using the START_AREA value which is currently set to AR0602 for Shadows of Amn. Loads 2da file under the CAMPAIGN.2DA IWDPARTY column.

Writes to Baldur.lua the active campaign id, the Active Campaign key value under the Program Options section.

CScreenStart::OnSoAButtonClick is called from CScreenStart::TimerAsynchronousUpdate and tolua_BaldurLUA_CScreenStart_OnSoAButtonClick00

---

CScreenStart::OnTBPButtonClick

Event action for when The Black Pits button is clicked

void CScreenStart::OnTBPButtonClick(bool playIntro);

Parameters

• bool playIntro - play intro movie or not

Remarks

Optionally plays intro movie if playIntro parameter is true. Plays BLACKPIT.WBM movie.

Sets start area based on contents of STARTBP.2DA - using the START_AREA value which is currently set to OH8000 for The Black Pits. Loads 2da file under the CAMPAIGN.2DA TBPPARTY column.

Writes to Baldur.lua the active campaign id, the Active Campaign key value under the Program Options section.

CScreenStart::OnTBPButtonClick is called from CScreenStart::TimerAsynchronousUpdate and tolua_BaldurLUA_CScreenStart_OnTBPButtonClick00

---

CScreenStart::OnToBButtonClick

Event action for when Throne of Bhaal button is clicked

void CScreenStart::OnToBButtonClick(bool playIntro);

Parameters

• bool playIntro - play intro movie or not

Remarks

Optionally plays intro movie if playIntro parameter is true. Plays INTRO.WBM movie (references HOWSEER as an alternative movie?).

Sets start area based on contents of STARTARE.2DA - using the START_AREA_MP value which is currently set to AR4000 for Throne of Bhaal. Loads 2da file under the CAMPAIGN.2DA HOWPARTY column.

Writes to Baldur.lua the active campaign id, the Active Campaign key value under the Program Options section.

CScreenStart::OnToBButtonClick is called from tolua_BaldurLUA_CScreenStart_OnToBButtonClick00

---

CScreenStart::OnTutorialButtonClick

Event action for when tutorial button is clicked

void CScreenStart::OnTutorialButtonClick();

Remarks

Sets start area based on contents of STARTARE.2DA - using the START_AREA_TUTORIAL value which is currently set to AR0015 for Tutorial

Calls CScreenStart::OnNewGameButtonClick to start a new game begining with the tutorial.

CScreenStart::OnTutorialButtonClick is called from tolua_BaldurLUA_CScreenStart_OnTutorialButtonClick00

---

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