CBaldurChitin Class¶

Overview
Quick Reference
Constructors
Methods

Overview¶

The structure used for this class is CBaldurChitin

Quick Reference¶

Quick Ref

void CBaldurChitin::CBaldurChitin(int argc, char** argv)

void CBaldurChitin::~CBaldurChitin()

void CBaldurChitin::AddPlayedMovie(CResRef& cResMovie)

virtual CRes* CBaldurChitin::AllocResObject(int nType)

virtual void CBaldurChitin::AsynchronousUpdate(unsigned int uTimerID, unsigned int uMsg, unsigned long dwUser, unsigned long dw1, unsigned long dw2)

virtual void CBaldurChitin::BroadcastMultiplayerProgressBarInfo()

void CBaldurChitin::CheckGUISong()

virtual int CBaldurChitin::ConfirmQuit()

virtual unsigned char CBaldurChitin::CutsceneModeActive()

virtual int CBaldurChitin::FontRectOutline()

virtual int CBaldurChitin::GetEAXActive()

virtual void CBaldurChitin::GetGameSpyCode(CString& sGameSpyCode)

virtual void CBaldurChitin::GetGameSpyGameName(CString& sGameSpyName)

virtual CString& CBaldurChitin::GetIconRes()

virtual unsigned long CBaldurChitin::GetIDSBadDeskTopBitDepth()

virtual unsigned long CBaldurChitin::GetIDSChoosePixelFormat()

virtual unsigned long CBaldurChitin::GetIDSExclusiveMode()

virtual unsigned long CBaldurChitin::GetIDSInvalidVideoMode()

virtual unsigned long CBaldurChitin::GetIDSOpenGLDll()

virtual unsigned long CBaldurChitin::GetIDSSetGameBitDepth()

virtual unsigned long CBaldurChitin::GetIDSSetGameResolution()

virtual unsigned long CBaldurChitin::GetIDSSetPixelFormat()

virtual unsigned long CBaldurChitin::GetIDSWindowsFonts()

virtual const char* CBaldurChitin::GetKeyFileName()

virtual long CBaldurChitin::GetMovieVolume()

virtual unsigned short CBaldurChitin::GetMultiplayerDirectPlayPort()

virtual unsigned short CBaldurChitin::GetMultiplayerGameSpyPort()

virtual unsigned char CBaldurChitin::GetNumberSoundChannels()

virtual void CBaldurChitin::GetPanicCDStrings(CString& sMediaRemoved, CString& sPlaceCD, CString& sInDrive)

CStringList* CBaldurChitin::GetPlayedMovies()

virtual void CBaldurChitin::GetScreenShotFilePrefix(CString& szGameFileName)

virtual unsigned char CBaldurChitin::GetSoundEnvironment(CString stAreaRef, unsigned long& dwEnvironment, float& fDamping, float& fDecay, float& fVolume, float& fReverbLevel)

void CBaldurChitin::Init()

virtual int CBaldurChitin::Is3DSound(int nChannel)

void CBaldurChitin::LoadDialogFiles()

virtual void CBaldurChitin::LoadOptions()

virtual void __cdecl CBaldurChitin::Log(const char* format, …) = 0

virtual int CBaldurChitin::MessageCallback(unsigned char* pData, unsigned long dwSize)

virtual void CBaldurChitin::OnMixerInitialize()

virtual void CBaldurChitin::OnMultiplayerPlayerJoin(int playerID, CString& sPlayerName)

virtual void CBaldurChitin::OnMultiplayerPlayerLeave(int playerID, CString& sPlayerName)

virtual void CBaldurChitin::OnMultiplayerPlayerVisible(int playerID)

virtual void CBaldurChitin::OnMultiplayerSessionClose()

virtual void CBaldurChitin::OnMultiplayerSessionOpen(CString& sJoinedGame, CString& sDroppedGame, CString& sLeftGame)

virtual void CBaldurChitin::OnMultiplayerSessionToClose()

virtual void CBaldurChitin::PreLoadFonts()

void CBaldurChitin::SaveOptions()

virtual void CBaldurChitin::SetProgressBar(unsigned char bEnabled, long nProgressBarCaption, int nBytesCopied, int nTotalBytes, unsigned char bTravel, long nParchmentCaption, unsigned char bWaiting, long nWaitingReason, unsigned char bDisplayMinibars, unsigned char bTimeoutCounter, unsigned long nSecondsToTimeout)

virtual void CBaldurChitin::SetProgressBarActivateEngine(int bValue)

virtual void CBaldurChitin::SetSoundVolumes()

virtual void CBaldurChitin::SetupPanels()

virtual void CBaldurChitin::ShutDown(int nLineNumber, char* szFileName, const char* text)

virtual void CBaldurChitin::SynchronousUpdate()

virtual void CBaldurChitin::UnloadFonts()

Constructors¶

Name	Description
CBaldurChitin::CBaldurChitin	Constructs a `CBaldurChitin` object
CBaldurChitin::~CBaldurChitin	Destroys a `CBaldurChitin` object

CBaldurChitin::CBaldurChitin¶

Constructs a CBaldurChitin object

void CBaldurChitin::CBaldurChitin(
   int argc,
   char** argv);

Parameters

int argc - An integer that contains the count of arguments that follow in argv
char** argv - An array of null-terminated strings representing command-line arguments

Remarks

By convention, argv[0] is the command with which the program is invoked, argv[1] is the first command-line argument, and so on.

Constructs a CBaldurChitin object

CBaldurChitin::~CBaldurChitin¶

Destroys the CBaldurChitin object

void CBaldurChitin::~CBaldurChitin()

Remarks

Destroys the CBaldurChitin object

Methods¶

Name	Description
CBaldurChitin::AddPlayedMovie	Add a movie to the already played list
CBaldurChitin::AllocResObject	Creates and allocates memory for a resource
CBaldurChitin::AsynchronousUpdate
CBaldurChitin::BroadcastMultiplayerProgressBarInfo	Broadcast to all connected sessions the progress bar information
CBaldurChitin::CheckGUISong
CBaldurChitin::ConfirmQuit	Displays a prompt to confirm if players wishes to quit, save before quit, etc
CBaldurChitin::CutsceneModeActive	Determines if the cutscene mode is active or not (for dreams etc)
CBaldurChitin::FontRectOutline
CBaldurChitin::GetEAXActive	Determines if the EAX sound feature is active or not
CBaldurChitin::GetGameSpyCode	Gets the game spy code
CBaldurChitin::GetGameSpyGameName	Gets the game spy game name
CBaldurChitin::GetIconRes	Gets default icon resolution
CBaldurChitin::GetIDSBadDeskTopBitDepth
CBaldurChitin::GetIDSChoosePixelFormat
CBaldurChitin::GetIDSExclusiveMode
CBaldurChitin::GetIDSInvalidVideoMode
CBaldurChitin::GetIDSOpenGLDll
CBaldurChitin::GetIDSSetGameBitDepth
CBaldurChitin::GetIDSSetGameResolution
CBaldurChitin::GetIDSSetPixelFormat
CBaldurChitin::GetIDSWindowsFonts
CBaldurChitin::GetKeyFileName	Returns a pointer to a string containing the default key file (usually `chitin.key`)
CBaldurChitin::GetMovieVolume	Returns movie volume
CBaldurChitin::GetMultiplayerDirectPlayPort	Returns port no used in DirectPlay
CBaldurChitin::GetMultiplayerGameSpyPort	Returns port no used in GameSpy
CBaldurChitin::GetNumberSoundChannels	Returns number of sound channels supported by local machine
CBaldurChitin::GetPanicCDStrings	Legacy function for when game was distributed on CD/DVD
CBaldurChitin::GetPlayedMovies	Returns a list of movies that have been played
CBaldurChitin::GetScreenShotFilePrefix
CBaldurChitin::GetSoundEnvironment
CBaldurChitin::Init	Initialize CBaldurChitin class
CBaldurChitin::Is3DSound*	Returns if 3D sound is supported on local machine
CBaldurChitin::LoadDialogFiles	Load dialog files
CBaldurChitin::LoadOptions	Load options
CBaldurChitin::Log	Output text to a log, similar to printf and uses variable no of arguments
CBaldurChitin::MessageCallback
CBaldurChitin::OnMixerInitialize
CBaldurChitin::OnMultiplayerPlayerJoin	Event action when a player joins a multiplayer game session
CBaldurChitin::OnMultiplayerPlayerLeave	Event action when a player leaves a multiplayer game session
CBaldurChitin::OnMultiplayerPlayerVisible	Event action when a player in a multiplayer game session becomes visible to others
CBaldurChitin::OnMultiplayerSessionClose	Event action when a multiplayer game session closes
CBaldurChitin::OnMultiplayerSessionOpen	Event action when a multiplayer game session opens
CBaldurChitin::OnMultiplayerSessionToClose	Event action when a multiplayer game session is about to close
CBaldurChitin::PreLoadFonts	Preload fonts for game
CBaldurChitin::SaveOptions	Save options
CBaldurChitin::SetProgressBar	Set progress bar on screen
CBaldurChitin::SetProgressBarActivateEngine
CBaldurChitin::SetSoundVolumes
CBaldurChitin::SetupPanels
CBaldurChitin::ShutDown
CBaldurChitin::SynchronousUpdate
CBaldurChitin::UnloadFonts	Unload fonts previously loaded by game engine, typically when game is closing

CBaldurChitin::AddPlayedMovie¶

Add a movie to the already played list

void CBaldurChitin::AddPlayedMovie(CResRef& cResMovie);

Parameters

CResRef& cResMovie - resource reference of movie to add to played list

Remarks

CBaldurChitin::AllocResObject¶

Creates and allocates memory for a resource

virtual CRes* CBaldurChitin::AllocResObject(int nType);

Parameters

int nType - type of resource to create

Return Value

Returns a CRes object

Remarks

CBaldurChitin::AsynchronousUpdate¶

virtual void CBaldurChitin::AsynchronousUpdate(
   unsigned int uTimerID,
   unsigned int uMsg,
   unsigned long dwUser,
   unsigned long dw1,
   unsigned long dw2);

Parameters

unsigned int uTimerID -
unsigned int uMsg -
unsigned long dwUser -
unsigned long dw1 -
unsigned long dw2 -

Remarks

CBaldurChitin::BroadcastMultiplayerProgressBarInfo¶

Broadcast to all connected sessions the progress bar information

virtual void CBaldurChitin::BroadcastMultiplayerProgressBarInfo();

Remarks

CBaldurChitin::CheckGUISong¶

void CBaldurChitin::CheckGUISong();

Remarks

CBaldurChitin::ConfirmQuit¶

Displays a prompt to confirm if players wishes to quit, save before quit, etc

virtual int CBaldurChitin::ConfirmQuit();

Return Value

Returns an int

Remarks

CBaldurChitin::CutsceneModeActive¶

Determines if the cutscene mode is active or not (for dreams etc)

virtual unsigned char CBaldurChitin::CutsceneModeActive();

Return Value

Returns a unsigned char

Remarks

CBaldurChitin::FontRectOutline¶

virtual int CBaldurChitin::FontRectOutline();

Return Value

Returns an int

Remarks

CBaldurChitin::GetEAXActive¶

Determines if the EAX sound feature is active or not

virtual int CBaldurChitin::GetEAXActive();

Return Value

Returns an int representing true 1 or false 0

Remarks

CBaldurChitin::GetGameSpyCode¶

Gets the game spy code

virtual void CBaldurChitin::GetGameSpyCode(CString& sGameSpyCode);

Parameters

CString& sGameSpyCode - address of string to store the game spy code in

Remarks

CBaldurChitin::GetGameSpyGameName¶

Gets the game spy game name

virtual void CBaldurChitin::GetGameSpyGameName(CString& sGameSpyName);

Parameters

CString& sGameSpyName - address of string to store the game spy name in

Remarks

CBaldurChitin::GetIconRes¶

Gets default icon resolution

virtual CString& CBaldurChitin::GetIconRes();

Return Value

Returns a CString&

Remarks

CBaldurChitin::GetIDSBadDeskTopBitDepth¶

virtual unsigned long CBaldurChitin::GetIDSBadDeskTopBitDepth();

Return Value

Returns an unsigned long

Remarks

CBaldurChitin::GetIDSChoosePixelFormat¶

virtual unsigned long CBaldurChitin::GetIDSChoosePixelFormat();

Return Value

Returns an unsigned long

Remarks

CBaldurChitin::GetIDSExclusiveMode¶

virtual unsigned long CBaldurChitin::GetIDSExclusiveMode();

Return Value

Returns an unsigned long

Remarks

CBaldurChitin::GetIDSInvalidVideoMode¶

virtual unsigned long CBaldurChitin::GetIDSInvalidVideoMode();

Return Value

Returns an unsigned long

Remarks

CBaldurChitin::GetIDSOpenGLDll¶

virtual unsigned long CBaldurChitin::GetIDSOpenGLDll();

Return Value

Returns an unsigned long

Remarks

CBaldurChitin::GetIDSSetGameBitDepth¶

virtual unsigned long CBaldurChitin::GetIDSSetGameBitDepth();

Return Value

Returns an unsigned long

Remarks

CBaldurChitin::GetIDSSetGameResolution¶

virtual unsigned long CBaldurChitin::GetIDSSetGameResolution();

Return Value

Returns an unsigned long

Remarks

CBaldurChitin::GetIDSSetPixelFormat¶

virtual unsigned long CBaldurChitin::GetIDSSetPixelFormat();

Return Value

Returns an unsigned long

Remarks

CBaldurChitin::GetIDSWindowsFonts¶

virtual unsigned long CBaldurChitin::GetIDSWindowsFonts();

Return Value

Returns an unsigned long

Remarks

CBaldurChitin::GetKeyFileName¶

Returns a pointer to a string containing the default key file (usually chitin.key) for the game engine

virtual const char* CBaldurChitin::GetKeyFileName();

Return Value

Returns const char*, a pointer to a string containing key file

Remarks

CBaldurChitin::GetMovieVolume¶

Returns movie volume

virtual long CBaldurChitin::GetMovieVolume();

Return Value

Returns long representing movie volume

Remarks

CBaldurChitin::GetMultiplayerDirectPlayPort¶

Returns port no used in DirectPlay

virtual unsigned short CBaldurChitin::GetMultiplayerDirectPlayPort();

Return Value

Returns an unsigned short representing the port

Remarks

CBaldurChitin::GetMultiplayerGameSpyPort¶

Returns port no used in GameSpy

virtual unsigned short CBaldurChitin::GetMultiplayerGameSpyPort();

Return Value

Returns an unsigned short representing the port

Remarks

CBaldurChitin::GetNumberSoundChannels¶

Returns number of sound channels supported by local machine

virtual unsigned char CBaldurChitin::GetNumberSoundChannels();

Return Value

Returns unsigned char

Remarks

CBaldurChitin::GetPanicCDStrings¶

Legacy function for when game was distributed on CD/DVD

virtual void CBaldurChitin::GetPanicCDStrings(
   CString& sMediaRemoved,
   CString& sPlaceCD,
   CString& sInDrive);

Parameters

CString& sMediaRemoved - address of string to store media string
CString& sPlaceCD - address of string to store place cd/dvd string
CString& sInDrive - address of string to store in drive string

Remarks

CBaldurChitin::GetPlayedMovies¶

Returns a list of movies that have been played

CStringList* CBaldurChitin::GetPlayedMovies();

Return Value

Returns a CStringList*

Remarks

CBaldurChitin::GetScreenShotFilePrefix¶

virtual void CBaldurChitin::GetScreenShotFilePrefix(CString& szGameFileName);

Parameters

CString& szGameFileName - address of string to store screenshot filename prefix to

Remarks

CBaldurChitin::GetSoundEnvironment¶

virtual unsigned char CBaldurChitin::GetSoundEnvironment(
   CString stAreaRef,
   unsigned long& dwEnvironment,
   float& fDamping,
   float& fDecay,
   float& fVolume,
   float& fReverbLevel;

Parameters

CString stAreaRef - string containing area resource reference
unsigned long& dwEnvironment - address of long variable to store sound environment info
float& fDamping - address of float variable to store sound damping value
float& fDecay - address of float variable to store sound decay value
float& fVolume - address of float variable to store sound volume
float& fReverbLevel - address of float variable to store reverb level

Return Value

Returns unsigned char

Remarks

CBaldurChitin::Init¶

Initialize CBaldurChitin class

void CBaldurChitin::Init();

Remarks

CBaldurChitin::Is3DSound¶

Returns true if 3D sound is supported on local machine

virtual int CBaldurChitin::Is3DSound(int nChannel);

Parameters

int nChannel -

Return Value

Returns an int representing true 1 or false 0

Remarks

CBaldurChitin::LoadDialogFiles¶

Load dialog files

void CBaldurChitin::LoadDialogFiles();

Remarks

CBaldurChitin::LoadOptions¶

Load options

virtual void CBaldurChitin::LoadOptions();

Remarks

CBaldurChitin::Log¶

Output text to a log, similar to printf and uses variable no of arguments after the format string

virtual void __cdecl CBaldurChitin::Log(
   const char* format,
   ...);

Parameters

const char* format - special format string for handling other passed parameters
… - * *

Remarks

CBaldurChitin::MessageCallback¶

virtual int CBaldurChitin::MessageCallback(
   unsigned char* pData,
   unsigned long dwSize);

Parameters

unsigned char* pData - pointer to data to send in message callback
unsigned long dwSize - size of message callback data

Return Value

Returns int

Remarks

CBaldurChitin::OnMixerInitialize¶

virtual void CBaldurChitin::OnMixerInitialize();

Remarks

CBaldurChitin::OnMultiplayerPlayerJoin¶

Event action when a player joins a multiplayer game session

virtual void CBaldurChitin::OnMultiplayerPlayerJoin(
   int playerID,
   CString& sPlayerName);

Parameters

int playerID - id of player joining multiplayer session
CString& sPlayerName - address of string variable that contains player name

Remarks

CBaldurChitin::OnMultiplayerPlayerLeave¶

Event action when a player leaves a multiplayer game session

virtual void CBaldurChitin::OnMultiplayerPlayerLeave(
   int playerID,
   CString& sPlayerName);

Parameters

int playerID - id of player leaving multiplayer session
CString& sPlayerName - address of string variable that contains player name

Remarks

CBaldurChitin::OnMultiplayerPlayerVisible¶

Event action when a player in a multiplayer game session becomes visible to other existing players

virtual void CBaldurChitin::OnMultiplayerPlayerVisible(int playerID);

Parameters

int playerID - id of multiplayer player

Remarks

CBaldurChitin::OnMultiplayerSessionClose¶

Event action when a multiplayer game session closes

virtual void CBaldurChitin::OnMultiplayerSessionClose();

Remarks

CBaldurChitin::OnMultiplayerSessionOpen¶

Event action when a multiplayer game session opens

virtual void CBaldurChitin::OnMultiplayerSessionOpen(
   CString& sJoinedGame,
   CString& sDroppedGame,
   CString& sLeftGame);

Parameters

CString& sJoinedGame - address of string containing joined game text
CString& sDroppedGame - address of string containing dropped game text
CString& sLeftGame - address of string containing left game text

Remarks

CBaldurChitin::OnMultiplayerSessionToClose¶

Event action when a multiplayer game session is about to close

virtual void CBaldurChitin::OnMultiplayerSessionToClose();

Remarks

CBaldurChitin::PreLoadFonts¶

Preload fonts for game

virtual void CBaldurChitin::PreLoadFonts();

Remarks

CBaldurChitin::SaveOptions¶

Save options

void CBaldurChitin::SaveOptions();

Remarks

CBaldurChitin::SetProgressBar¶

Set progress bar on screen

virtual void CBaldurChitin::SetProgressBar(
   unsigned char bEnabled,
   long nProgressBarCaption,
   int nBytesCopied,
   int nTotalBytes,
   unsigned char bTravel,
   long nParchmentCaption,
   unsigned char bWaiting,
   long nWaitingReason,
   unsigned char bDisplayMinibars,
   unsigned char bTimeoutCounter,
   unsigned long nSecondsToTimeout);

Parameters

unsigned char bEnabled -
long nProgressBarCaption -
int nBytesCopied -
int nTotalBytes -
unsigned char bTravel -
long nParchmentCaption -
unsigned char bWaiting -
long nWaitingReason -
unsigned char bDisplayMinibars -
unsigned char bTimeoutCounter -
unsigned long nSecondsToTimeout -

Remarks

CBaldurChitin::SetProgressBarActivateEngine¶

virtual void CBaldurChitin::SetProgressBarActivateEngine(int bValue);

Parameters

int bValue -

Remarks

CBaldurChitin::SetSoundVolumes¶

virtual void CBaldurChitin::SetSoundVolumes();

Remarks

CBaldurChitin::SetupPanels¶

virtual void CBaldurChitin::SetupPanels();

Remarks

CBaldurChitin::ShutDown¶

virtual void CBaldurChitin::ShutDown(
   int nLineNumber,
   char* szFileName,
   const char* text);

Parameters

int nLineNumber - line number that shutdown occured at
char* szFileName - file that shutdown occured at
const char* text - message text for shutdown reason to output to log

Remarks

CBaldurChitin::SynchronousUpdate¶

virtual void CBaldurChitin::SynchronousUpdate();

Remarks

CBaldurChitin::UnloadFonts¶

Unload fonts previously loaded by game engine, typically when game is closing.

virtual void CBaldurChitin::UnloadFonts();

Remarks