CampaignManager Class Reference

#include <CampaignManager.h>

Inherits Snapshot.

Public Types
enum	{ INVALID_MISSION_NUMBER = -1 }

Public Member Functions
	CampaignManager (void)
	~CampaignManager (void)
virtual void	crc (Xfer *xfer)
	run the "light" crc check on this data structure
virtual void	xfer (Xfer *xfer)
virtual void	loadPostProcess (void)
void	init (void)
Campaign *	getCurrentCampaign (void)
	Returns a point to the current Campaign.
Mission *	getCurrentMission (void)
	Returns a point to the current mission.
Mission *	gotoNextMission (void)
	Set the next mission as the current Mission, and returns a point to it.
void	setCampaignAndMission (AsciiString campaign, AsciiString mission)
	Sets the campaing and Mission we're on.
void	setCampaign (AsciiString campaign)
	sets the campaign and set's it's first mission
AsciiString	getCurrentMap (void)
	Get the map located in m_currentMission;.
Int	getCurrentMissionNumber (void)
	get mission number for the currently loaded level if we are in a campaign
const FieldParse *	getFieldParse (void) const
	returns the parsing fields
Campaign *	newCampaign (AsciiString name)
Bool	isVictorious (void)
void	SetVictorious (Bool victory)
void	setRankPoints (Int rankPoints)
Int	getRankPoints () const
GameDifficulty	getGameDifficulty () const
void	setGameDifficulty (GameDifficulty d)
Public Member Functions inherited from Snapshot
	Snapshot (void)
	~Snapshot (void)

Static Public Member Functions
static void	parseMissionPart (INI *ini, void *instance, void *store, const void *userData)
	Parse the Mission Part.

Static Public Attributes
static const FieldParse	m_campaignFieldParseTable []
	the parse table

Detailed Description

Definition at line 117 of file CampaignManager.h.

Member Enumeration Documentation

anonymous enum

anonymous enum

Enumerator
INVALID_MISSION_NUMBER

Definition at line 135 of file CampaignManager.h.

Constructor & Destructor Documentation

CampaignManager()

CampaignManager::CampaignManager

(

void

)

Definition at line 221 of file CampaignManager.cpp.

~CampaignManager()

CampaignManager::~CampaignManager

(

void

)

Definition at line 233 of file CampaignManager.cpp.

Member Function Documentation

crc()

virtual void CampaignManager::crc ( Xfer * xfer )

inlinevirtual

run the "light" crc check on this data structure

Implements Snapshot.

Definition at line 124 of file CampaignManager.h.

getCurrentCampaign()

Campaign * CampaignManager::getCurrentCampaign

(

void

)

Returns a point to the current Campaign.

Definition at line 258 of file CampaignManager.cpp.

getCurrentMap()

AsciiString CampaignManager::getCurrentMap

(

void

)

Get the map located in m_currentMission;.

Definition at line 328 of file CampaignManager.cpp.

getCurrentMission()

Mission * CampaignManager::getCurrentMission

(

void

)

Returns a point to the current mission.

Definition at line 264 of file CampaignManager.cpp.

getCurrentMissionNumber()

Int CampaignManager::getCurrentMissionNumber

(

void

)

get mission number for the currently loaded level if we are in a campaign

Return the 0 based mission number

Definition at line 339 of file CampaignManager.cpp.

getFieldParse()

const FieldParse * CampaignManager::getFieldParse ( void ) const

inline

returns the parsing fields

Definition at line 138 of file CampaignManager.h.

getGameDifficulty()

GameDifficulty CampaignManager::getGameDifficulty ( ) const

inline

Definition at line 156 of file CampaignManager.h.

getRankPoints()

Int CampaignManager::getRankPoints ( ) const

inline

Definition at line 147 of file CampaignManager.h.

gotoNextMission()

Mission * CampaignManager::gotoNextMission

(

void

)

Set the next mission as the current Mission, and returns a point to it.

Definition at line 270 of file CampaignManager.cpp.

init()

void CampaignManager::init

(

void

)

Definition at line 250 of file CampaignManager.cpp.

isVictorious()

Bool CampaignManager::isVictorious ( void )

inline

Definition at line 143 of file CampaignManager.h.

loadPostProcess()

void CampaignManager::loadPostProcess ( void )

virtual

post process phase for loading save games. All save systems have their xfer run using XferLoad mode, and then all systems each have their post process run

Implements Snapshot.

Definition at line 501 of file CampaignManager.cpp.

newCampaign()

Campaign * CampaignManager::newCampaign

(

AsciiString

name

)

Definition at line 396 of file CampaignManager.cpp.

parseMissionPart()

void CampaignManager::parseMissionPart ( INI * ini, void * instance, void * store, const void * userData )

static

Parse the Mission Part.

Definition at line 364 of file CampaignManager.cpp.

setCampaign()

void CampaignManager::setCampaign

(

AsciiString

campaign

)

sets the campaign and set's it's first mission

Definition at line 304 of file CampaignManager.cpp.

setCampaignAndMission()

void CampaignManager::setCampaignAndMission	(	AsciiString	campaign,
		AsciiString	mission )

Sets the campaing and Mission we're on.

Definition at line 280 of file CampaignManager.cpp.

setGameDifficulty()

void CampaignManager::setGameDifficulty ( GameDifficulty d )

inline

Definition at line 157 of file CampaignManager.h.

setRankPoints()

void CampaignManager::setRankPoints ( Int rankPoints )

inline

Definition at line 146 of file CampaignManager.h.

SetVictorious()

void CampaignManager::SetVictorious ( Bool victory )

inline

Definition at line 144 of file CampaignManager.h.

xfer()

void CampaignManager::xfer ( Xfer * xfer )

virtual

Xfer method Version Info 1: Initial version 2: Added RankPoints Saving 4: Need to have Challenge info in Mission saves as well as normal saves

Implements Snapshot.

Definition at line 427 of file CampaignManager.cpp.

Member Data Documentation

m_campaignFieldParseTable

const FieldParse CampaignManager::m_campaignFieldParseTable

static

Initial value:

= 
{
 
    { "Mission",                        CampaignManager::parseMissionPart, NULL, NULL },
    { "FirstMission",               INI::parseAsciiString,                         NULL,   offsetof( Campaign, m_firstMission )  },
    { "CampaignNameLabel",  INI::parseAsciiString,                         NULL, offsetof( Campaign, m_campaignNameLabel ) },
    { "FinalVictoryMovie",  INI::parseAsciiString,                         NULL, offsetof( Campaign, m_finalMovieName ) },
    { "IsChallengeCampaign",            INI::parseBool,               NULL, offsetof( Campaign, m_isChallengeCampaign ) },
    { "PlayerFaction",      INI::parseAsciiString,                 NULL, offsetof( Campaign, m_playerFactionName ) },
 
    { NULL,                                     NULL,                                                   NULL, 0 }  
 
}

the parse table

Definition at line 76 of file CampaignManager.h.

---

The documentation for this class was generated from the following files:

• Code/GameEngine/Include/GameClient/CampaignManager.h
• Code/GameEngine/Source/GameClient/System/CampaignManager.cpp