CreditsManager Class Reference

#include <Credits.h>

Inherits SubsystemInterface.

Public Member Functions
	CreditsManager (void)
	~CreditsManager (void)
void	init (void)
void	load (void)
void	reset (void)
void	update (void)
void	draw (void)
const FieldParse *	getFieldParse () const
	returns the parsing fields
Bool	isFinished (void)
void	addBlank (void)
void	addText (AsciiString text)
Public Member Functions inherited from SubsystemInterface
	SubsystemInterface ()
virtual	~SubsystemInterface ()
virtual void	postProcessLoad ()
void	UPDATE (void)
void	DRAW (void)
AsciiString	getName (void)
void	setName (AsciiString name)

Static Public Member Functions
static void	parseBlank (INI *ini, void *instance, void *store, const void *userData)
	Parse the image part of the INI file.
static void	parseText (INI *ini, void *instance, void *store, const void *userData)
	Parse the image part of the INI file.

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

Additional Inherited Members
Protected Attributes inherited from SubsystemInterface
AsciiString	m_name

Detailed Description

Definition at line 111 of file Credits.h.

Constructor & Destructor Documentation

CreditsManager()

CreditsManager::CreditsManager

(

void

)

Definition at line 126 of file Credits.cpp.

~CreditsManager()

CreditsManager::~CreditsManager

(

void

)

Definition at line 139 of file Credits.cpp.

Member Function Documentation

addBlank()

void CreditsManager::addBlank

(

void

)

Definition at line 409 of file Credits.cpp.

addText()

void CreditsManager::addText

(

AsciiString

text

)

Definition at line 431 of file Credits.cpp.

draw()

void CreditsManager::draw ( void )

virtual

Reimplemented from SubsystemInterface.

Definition at line 354 of file Credits.cpp.

getFieldParse()

const FieldParse * CreditsManager::getFieldParse ( ) const

inline

returns the parsing fields

Definition at line 123 of file Credits.h.

init()

void CreditsManager::init ( void )

virtual

• Assign any default values to data required for the class
  • Allocate any memory and resources needed throughout the lifetime of the class

Implements SubsystemInterface.

Definition at line 152 of file Credits.cpp.

isFinished()

Bool CreditsManager::isFinished ( void )

inline

Definition at line 128 of file Credits.h.

load()

void CreditsManager::load

(

void

)

Definition at line 159 of file Credits.cpp.

parseBlank()

void CreditsManager::parseBlank ( INI * ini, void * instance, void * store, const void * userData )

static

Parse the image part of the INI file.

Definition at line 418 of file Credits.cpp.

parseText()

void CreditsManager::parseText ( INI * ini, void * instance, void * store, const void * userData )

static

Parse the image part of the INI file.

Definition at line 424 of file Credits.cpp.

reset()

void CreditsManager::reset ( void )

virtual

• Any system should be able to reset all data and go back to an empty state that is ready to accept a completely new set of data. Reset() can expect to be used in the context of resetting the engine in order to start or load a new game.
  • Do NOT free and re-allocate resources needed, where possible reorganize and re-initialize the resources already allocated.
  • After a reset, the system does not need to be in EXACTLY the same state as a fresh instantiation. If there are persistent state information for the system make sure you maintain it while restoring or re-initializing other transient parts.

Implements SubsystemInterface.

Definition at line 177 of file Credits.cpp.

update()

void CreditsManager::update ( void )

virtual

• Update methods are the place to do system per frame processing. You should call the system update once each time through the game loop to service the system.
  • Note that currently the GameClient and GameLogic will be updating at different rates where the logic is running real time, and the client will adjust how many loops can be done during one server time slice in order to improve performance on low end machines.

Implements SubsystemInterface.

Definition at line 186 of file Credits.cpp.

Member Data Documentation

m_creditsFieldParseTable

const FieldParse CreditsManager::m_creditsFieldParseTable

static

Initial value:

= 
{
 
    { "ScrollRate",                 INI::parseInt,                                         NULL, offsetof( CreditsManager, m_scrollRate )    },
    { "ScrollRateEveryFrames",  INI::parseInt,                                         NULL, offsetof( CreditsManager, m_scrollRatePerFrames )   },
    { "ScrollDown",                 INI::parseBool,                                           NULL,   offsetof( CreditsManager, m_scrollDown )  },
    { "TitleColor",                 INI::parseColorInt,                                   NULL,   offsetof( CreditsManager, m_titleColor )  },
    { "MinorTitleColor",        INI::parseColorInt,                                   NULL,   offsetof( CreditsManager, m_positionColor )  },
    { "NormalColor",                INI::parseColorInt,                                   NULL,   offsetof( CreditsManager, m_normalColor )  },
    { "Style",                          INI::parseLookupList,                               CreditStyleNames,   offsetof( CreditsManager, m_currentStyle )  },
    { "Blank",                          CreditsManager::parseBlank,                   NULL,   NULL  },
    { "Text",                               CreditsManager::parseText,                 NULL,   NULL  },
 
    { NULL,                                     NULL,                                                   NULL, 0 }  
 
}

the parse table

Definition at line 71 of file Credits.h.

---

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

• Code/GameEngine/Include/GameClient/Credits.h
• Code/GameEngine/Source/GameClient/Credits.cpp