CMultiplayerSettings Class¶

Overview
Quick Reference
Constructors
Methods

Overview¶

Note

The CMultiplayerSettings class handles settings for multiplayer game sessions

The structure used for this class is CMultiplayerSettings

Quick Reference¶

Quick Ref

void CMultiplayerSettings::CMultiplayerSettings()

void CMultiplayerSettings::~CMultiplayerSettings()

int CMultiplayerSettings::GetCharacterControlledByPlayer(int nCharacterSlot)

unsigned char CMultiplayerSettings::GetCharacterReady(int nCharacterSlot)

unsigned char CMultiplayerSettings::GetCharacterStatus(int nCharacterSlot)

unsigned long CMultiplayerSettings::GetDataSize()

unsigned char CMultiplayerSettings::GetPermission(int nPlayerSlot, int nPermission)

unsigned char CMultiplayerSettings::GetPlayerReady(short nPlayerSlot)

unsigned char CMultiplayerSettings::GetPlayerReady(int idPlayer)

void CMultiplayerSettings::InitializeSettings()

void CMultiplayerSettings::Marshal(unsigned char** pData, unsigned long* dwSize)

void CMultiplayerSettings::OnDropPlayer(int idDroppedPlayer)

void CMultiplayerSettings::ResetPermissionsForPlayer(int nPlayerSlot, unsigned char bFlush)

void CMultiplayerSettings::ResetServerOnLoadGame()

void CMultiplayerSettings::SetAllowReformPartyOption(unsigned char bReformParty, unsigned char bFlush)

void CMultiplayerSettings::SetArbitrationLockAllowInput(unsigned char bStatus)

void CMultiplayerSettings::SetArbitrationLockStatus(unsigned char bStatus)

void CMultiplayerSettings::SetCharacterControlledByPlayer(int nCharacterSlot, int nPlayerSlot, unsigned char bFlush, unsigned char bCharacterUpdate)

void CMultiplayerSettings::SetCharacterCreationLocation(CString areaName, CPoint ptStart)

void CMultiplayerSettings::SetCharacterReady(int nCharacterSlot, unsigned char bReady, unsigned char bFlush)

void CMultiplayerSettings::SetImportingCharacterOption(unsigned char nImportingBitField)

void CMultiplayerSettings::SetListenToJoinOption(unsigned char bListenToJoin, unsigned char bFlush)

void CMultiplayerSettings::SetPermission(int nPlayerSlot, int nPermission, unsigned char bPermissionValue, unsigned char bFlush)

void CMultiplayerSettings::SetPlayerReady(int idPlayer, unsigned char bValue, unsigned char bFlush)

void CMultiplayerSettings::SetRestrictStoreOption(unsigned char bRestrictStore)

void CMultiplayerSettings::SetServerOnLoadGame(int localPlayerID)

void CMultiplayerSettings::SignalCharacterStatus(int nCharacterSlot, unsigned char nStatus, unsigned char bLocalMessage, unsigned char bFlush)

void CMultiplayerSettings::Unmarshal(unsigned char* pData, unsigned long dwSize)

Constructors¶

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

CMultiplayerSettings::CMultiplayerSettings¶

Constructs a CMultiplayerSettings object

void CMultiplayerSettings::CMultiplayerSettings();

Remarks

Constructs a CMultiplayerSettings object

CMultiplayerSettings::~CMultiplayerSettings¶

Destroys the CMultiplayerSettings object

void CMultiplayerSettings::~CMultiplayerSettings();

Remarks

Destroys the CMultiplayerSettings object

Methods¶

Name	Description
CMultiplayerSettings::GetCharacterControlledByPlayer
CMultiplayerSettings::GetCharacterReady
CMultiplayerSettings::GetCharacterStatus
CMultiplayerSettings::GetDataSize
CMultiplayerSettings::GetPermission
CMultiplayerSettings::GetPlayerReady
CMultiplayerSettings::InitializeSettings
CMultiplayerSettings::Marshal
CMultiplayerSettings::OnDropPlayer
CMultiplayerSettings::ResetPermissionsForPlayer
CMultiplayerSettings::ResetServerOnLoadGame
CMultiplayerSettings::SetAllowReformPartyOption
CMultiplayerSettings::SetArbitrationLockAllowInput
CMultiplayerSettings::SetArbitrationLockStatus
CMultiplayerSettings::SetCharacterControlledByPlayer
CMultiplayerSettings::SetCharacterCreationLocation
CMultiplayerSettings::SetCharacterReady
CMultiplayerSettings::SetImportingCharacterOption
CMultiplayerSettings::SetListenToJoinOption
CMultiplayerSettings::SetPermission
CMultiplayerSettings::SetPlayerReady
CMultiplayerSettings::SetRestrictStoreOption
CMultiplayerSettings::SetServerOnLoadGame
CMultiplayerSettings::SignalCharacterStatus
CMultiplayerSettings::Unmarshal

CMultiplayerSettings::GetCharacterControlledByPlayer¶

int CMultiplayerSettings::GetCharacterControlledByPlayer(int nCharacterSlot);

Parameters

int nCharacterSlot -

Return Value

int

Remarks

CMultiplayerSettings::GetCharacterReady¶

unsigned char CMultiplayerSettings::GetCharacterReady(int nCharacterSlot);

Parameters

int nCharacterSlot -

Return Value

unsigned char

Remarks

CMultiplayerSettings::GetCharacterStatus¶

unsigned char CMultiplayerSettings::GetCharacterStatus(int nCharacterSlot);

Parameters

int nCharacterSlot -

Return Value

unsigned char

Remarks

CMultiplayerSettings::GetDataSize¶

unsigned long CMultiplayerSettings::GetDataSize();

Return Value

unsigned long

Remarks

CMultiplayerSettings::GetPermission¶

unsigned char CMultiplayerSettings::GetPermission(int nPlayerSlot, int nPermission);

Parameters

int nPlayerSlot -
int nPermission -

Return Value

unsigned char

Remarks

CMultiplayerSettings::GetPlayerReady¶

unsigned char CMultiplayerSettings::GetPlayerReady(short nPlayerSlot);

Parameters

short nPlayerSlot -

Return Value

unsigned char

Remarks

CMultiplayerSettings::GetPlayerReady¶

unsigned char CMultiplayerSettings::GetPlayerReady(int idPlayer);

Parameters

int idPlayer -

Return Value

unsigned char

Remarks

CMultiplayerSettings::InitializeSettings¶

void CMultiplayerSettings::InitializeSettings();

Remarks

CMultiplayerSettings::Marshal¶

void CMultiplayerSettings::Marshal(
   unsigned char** pData,
   unsigned long* dwSize);

Parameters

unsigned char** pData -
unsigned long* dwSize -

Remarks

CMultiplayerSettings::OnDropPlayer¶

void CMultiplayerSettings::OnDropPlayer(int idDroppedPlayer);

Parameters

int idDroppedPlayer -

Remarks

CMultiplayerSettings::ResetPermissionsForPlayer¶

void CMultiplayerSettings::ResetPermissionsForPlayer(
   int nPlayerSlot,
   unsigned char bFlush);

Parameters

int nPlayerSlot -
unsigned char bFlush -

Remarks

CMultiplayerSettings::ResetServerOnLoadGame¶

void CMultiplayerSettings::ResetServerOnLoadGame();

Remarks

CMultiplayerSettings::SetAllowReformPartyOption¶

void CMultiplayerSettings::SetAllowReformPartyOption(
   unsigned char bReformParty,
   unsigned char bFlush);

Parameters

unsigned char bReformParty -
unsigned char bFlush -

Remarks

CMultiplayerSettings::SetArbitrationLockAllowInput¶

void CMultiplayerSettings::SetArbitrationLockAllowInput(unsigned char bStatus);

Parameters

unsigned char bStatus -

Remarks

CMultiplayerSettings::SetArbitrationLockStatus¶

void CMultiplayerSettings::SetArbitrationLockStatus(unsigned char bStatus);

Parameters

unsigned char bStatus -

Remarks

CMultiplayerSettings::SetCharacterControlledByPlayer¶

void CMultiplayerSettings::SetCharacterControlledByPlayer(
   int nCharacterSlot,
   int nPlayerSlot,
   unsigned char bFlush,
   unsigned char bCharacterUpdate);

Parameters

int nCharacterSlot -
int nPlayerSlot -
unsigned char bFlush -
unsigned char bCharacterUpdate -

Remarks

CMultiplayerSettings::SetCharacterCreationLocation¶

void CMultiplayerSettings::SetCharacterCreationLocation(
   CString areaName,
   CPoint ptStart);

Parameters

CString areaName -
CPoint ptStart -

Remarks

CMultiplayerSettings::SetCharacterReady¶

void CMultiplayerSettings::SetCharacterReady(
   int nCharacterSlot,
   unsigned char bReady,
   unsigned char bFlush);

Parameters

int nCharacterSlot -
unsigned char bReady -
unsigned char bFlush -

Remarks

CMultiplayerSettings::SetImportingCharacterOption¶

void CMultiplayerSettings::SetImportingCharacterOption(unsigned char nImportingBitField);

Parameters

unsigned char nImportingBitField -

Remarks

CMultiplayerSettings::SetListenToJoinOption¶

void CMultiplayerSettings::SetListenToJoinOption(
   unsigned char bListenToJoin,
   unsigned char bFlush);

Parameters

unsigned char bListenToJoin -
unsigned char bFlush -

Remarks

CMultiplayerSettings::SetPermission¶

void CMultiplayerSettings::SetPermission(
   int nPlayerSlot,
   int nPermission,
   unsigned char bPermissionValue,
   unsigned char bFlush);

Parameters

int nPlayerSlot -
int nPermission -
unsigned char bPermissionValue -
unsigned char bFlush -

Remarks

CMultiplayerSettings::SetPlayerReady¶

void CMultiplayerSettings::SetPlayerReady(
   int idPlayer,
   unsigned char bValue,
   unsigned char bFlush);

Parameters

int idPlayer -
unsigned char bValue -
unsigned char bFlush -

Remarks

CMultiplayerSettings::SetRestrictStoreOption¶

void CMultiplayerSettings::SetRestrictStoreOption(unsigned char bRestrictStore);

Parameters

unsigned char bRestrictStore -

Remarks

CMultiplayerSettings::SetServerOnLoadGame¶

void CMultiplayerSettings::SetServerOnLoadGame(int localPlayerID);

Parameters

int localPlayerID -

Remarks

CMultiplayerSettings::SignalCharacterStatus¶

void CMultiplayerSettings::SignalCharacterStatus(
   int nCharacterSlot,
   unsigned char nStatus,
   unsigned char bLocalMessage,
   unsigned char bFlush);

Parameters

int nCharacterSlot -
unsigned char nStatus -
unsigned char bLocalMessage -
unsigned char bFlush -

Remarks

CMultiplayerSettings::Unmarshal¶

void CMultiplayerSettings::Unmarshal(
   unsigned char* pData,
   unsigned long dwSize);

Parameters

unsigned char* pData -
unsigned long dwSize -

Remarks