Skip to content

Class: CMainMenu ​

Main menu binding.

Source ​

C++ class CMainMenu

Custom Constructor ​

CMainMenu

Remarks ​

Engine-owned singleton returned by main_menu.get_main_menu().

Constructors ​

Constructor ​

ts
new CMainMenu(): CMainMenu;

Returns ​

CMainMenu

Methods ​

CancelDownload() ​

ts
CancelDownload(): void;

Cancel the active multiplayer map download.

Returns ​

void


GetAccountMngr() ​

ts
GetAccountMngr(): account_manager;

Get the multiplayer account manager.

Returns ​

account_manager

Account manager.


GetCDKey() ​

ts
GetCDKey(): string;

Get the CD key stored by the game.

Returns ​

string

CD key string.


GetDemoInfo() ​

ts
GetDemoInfo(fileName: string): Nullable<demo_info>;

Read metadata for a recorded demo file.

Parameters ​

ParameterTypeDescription
fileNamestringDemo file name.

Returns ​

Nullable<demo_info>

Demo info, or null when it cannot be read.


GetGSVer() ​

ts
GetGSVer(): string;

Get GameSpy protocol version string.

Returns ​

string

GameSpy version.


GetLoginMngr() ​

ts
GetLoginMngr(): login_manager;

Get the multiplayer login manager.

Returns ​

login_manager

Login manager.


GetPatchProgress() ​

ts
GetPatchProgress(): Patch_Dawnload_Progress;

Get patch download progress.

Returns ​

Patch_Dawnload_Progress

Patch progress object.


GetPlayerName() ​

ts
GetPlayerName(): string;

Get the current player name.

Returns ​

string

Player name.


GetProfileStore() ​

ts
GetProfileStore(): profile_store;

Get the multiplayer profile store.

Returns ​

profile_store

Profile store.


ValidateCDKey() ​

ts
ValidateCDKey(): boolean;

Validate the stored CD key.

Returns ​

boolean

Whether the CD key is valid.