fsIRunningOrder Class Reference

#include <fsIRunningOrder.h>

Inheritance diagram for fsIRunningOrder:

Public Member Functions
void	replace (const std::vector< fsStr > &pNewOrder)
const std::vector< fsStr > &	rawSequenceGet () const
fsBool	guiModeGet () const
const VarTableMap *	resolvedSceneConfigGet (const fsStr &pSceneName) const
fsS32	levelCountGet () const
fsS32	currLevelPosGet () const
const fsStr &	firstLocationGet () const
void	gameContinue ()
void	newGameStart ()
void	singleLevel ()
const fsStr &	nextLocationGet () const
void	levelCompleteSet ()
void	nextLocationSet (const fsStr &pNextLocation)
fsStr	nextLocationGet (const fsStr &pCurrentLocation) const
fsBool	nextLocationReady () const
void	nextLocationClear ()
	fsIRunningOrder (const fsCResourceName &pFilename, fsBool pMapNavigationUsed=false)
virtual	~fsIRunningOrder ()

Static Public Attributes
static const fsStr	mMapDestinationPrefix

Protected Member Functions
fsBool	loopsCheck () const
void	sequenceCheck ()
virtual void	sequenceCheckDo () const
virtual std::vector< fsStr >::const_iterator	currentLevelIteratorGetDo (const fsStr &pCurrentLocation) const
virtual void	nextLocationSetDo (const fsStr &pNextLocation)
virtual void	newGameStartDo ()
virtual fsStr	nextLocationGetDo (const fsStr &pCurrentLocation) const
virtual void	gameContinueDo ()=0
virtual void	replaceDo (const std::vector< fsStr > &pNewOrder)=0
std::vector< fsStr >::const_iterator	currentLevelIteratorGet (const fsStr &pCurrentLocation) const

Protected Attributes
std::vector< fsStr >	mSequence
fsStr	mCurrentLocation
fsStr	mNextLocation
fsBool	mHasLoops = false

Constructor & Destructor Documentation

fsIRunningOrder()

fsIRunningOrder::fsIRunningOrder	(	const fsCResourceName &	pFilename,
		fsBool	pMapNavigationUsed = false )

~fsIRunningOrder()

fsIRunningOrder::~fsIRunningOrder ( )

virtual

Member Function Documentation

currentLevelIteratorGet()

std::vector< fsStr >::const_iterator fsIRunningOrder::currentLevelIteratorGet ( const fsStr & pCurrentLocation ) const

protected

currentLevelIteratorGetDo()

std::vector< fsStr >::const_iterator fsIRunningOrder::currentLevelIteratorGetDo ( const fsStr & pCurrentLocation ) const

protectedvirtual

Reimplemented in gfCHogRunningOrder.

currLevelPosGet()

fsS32 fsIRunningOrder::currLevelPosGet

(

)

const

firstLocationGet()

const fsStr & fsIRunningOrder::firstLocationGet

(

)

const

gameContinue()

void fsIRunningOrder::gameContinue

(

)

gameContinueDo()

virtual void fsIRunningOrder::gameContinueDo ( )

protectedpure virtual

Implemented in gfCHogRunningOrder, and gfCParkRunningOrder.

guiModeGet()

fsBool fsIRunningOrder::guiModeGet ( ) const

inline

levelCompleteSet()

void fsIRunningOrder::levelCompleteSet

(

)

levelCountGet()

fsS32 fsIRunningOrder::levelCountGet

(

)

const

loopsCheck()

fsBool fsIRunningOrder::loopsCheck ( ) const

protected

newGameStart()

void fsIRunningOrder::newGameStart

(

)

newGameStartDo()

void fsIRunningOrder::newGameStartDo ( )

protectedvirtual

Reimplemented in gfCHogRunningOrder.

nextLocationClear()

void fsIRunningOrder::nextLocationClear

(

)

nextLocationGet() [1/2]

const fsStr & fsIRunningOrder::nextLocationGet

(

)

const

nextLocationGet() [2/2]

fsStr fsIRunningOrder::nextLocationGet

(

const fsStr &

pCurrentLocation

)

const

nextLocationGetDo()

fsStr fsIRunningOrder::nextLocationGetDo ( const fsStr & pCurrentLocation ) const

protectedvirtual

Reimplemented in gfCHogRunningOrder.

nextLocationReady()

fsBool fsIRunningOrder::nextLocationReady

(

)

const

nextLocationSet()

void fsIRunningOrder::nextLocationSet

(

const fsStr &

pNextLocation

)

nextLocationSetDo()

void fsIRunningOrder::nextLocationSetDo ( const fsStr & pNextLocation )

protectedvirtual

Reimplemented in gfCHogRunningOrder.

rawSequenceGet()

const std::vector< fsStr > & fsIRunningOrder::rawSequenceGet ( ) const

inline

replace()

void fsIRunningOrder::replace

(

const std::vector< fsStr > &

pNewOrder

)

replaceDo()

virtual void fsIRunningOrder::replaceDo ( const std::vector< fsStr > & pNewOrder )

protectedpure virtual

Implemented in gfCHogRunningOrder, and gfCParkRunningOrder.

resolvedSceneConfigGet()

const VarTableMap * fsIRunningOrder::resolvedSceneConfigGet

(

const fsStr &

pSceneName

)

const

sequenceCheck()

void fsIRunningOrder::sequenceCheck ( )

protected

sequenceCheckDo()

void fsIRunningOrder::sequenceCheckDo ( ) const

protectedvirtual

Reimplemented in gfCHogRunningOrder.

singleLevel()

void fsIRunningOrder::singleLevel

(

)

Member Data Documentation

mCurrentLocation

fsStr fsIRunningOrder::mCurrentLocation

protected

mHasLoops

fsBool fsIRunningOrder::mHasLoops = false

protected

mMapDestinationPrefix

const fsStr fsIRunningOrder::mMapDestinationPrefix

static

mNextLocation

fsStr fsIRunningOrder::mNextLocation

protected

mSequence

std::vector<fsStr> fsIRunningOrder::mSequence

protected

---

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

• /home/runner/work/fission/fission/libs/fsAppCore/fsIRunningOrder.h
• /home/runner/work/fission/fission/libs/fsAppCore/fsIRunningOrder.cpp