CrateTemplate Class Reference

#include <CrateSystem.h>

Inherits Overridable.

Public Member Functions
	CrateTemplate ()
void	setName (AsciiString name)
AsciiString	getName ()
const FieldParse *	getFieldParse () const
Public Member Functions inherited from Overridable
	Overridable ()
const Overridable *	getNextOverride (void) const
const Overridable *	getFinalOverride (void) const
void	setNextOverride (Overridable *nextOverridable)
Overridable *	friend_getNextOverride (void)
Overridable *	friend_getFinalOverride (void)
const Overridable *	friend_getFinalOverride (void) const
void	markAsOverride (void)
Overridable *	deleteOverrides (void)
Public Member Functions inherited from MemoryPoolObject
void	deleteInstance ()

Static Public Member Functions
static void	parseCrateCreationEntry (INI *ini, void *instance, void *store, const void *)

Public Attributes
AsciiString	m_name
	name for this CrateTemplate
Real	m_creationChance
	Condition for random percentage chance of creating.
VeterancyLevel	m_veterancyLevel
	Condition specifing level of killed unit.
KindOfMaskType	m_killedByTypeKindof
	Must be killed by something with all these bits set.
ScienceType	m_killerScience
	Must be killed by something posessing this science.
crateCreationEntryList	m_possibleCrates
	CreationChance is for this CrateData to succeed, this list controls one-of-n crates created on success.
Bool	m_isOwnedByMaker
	Design needs crates to be owned sometimes.

Static Public Attributes
static const FieldParse	TheCrateTemplateFieldParseTable []
	the parse table for INI definition

Additional Inherited Members
Protected Member Functions inherited from MemoryPoolObject
virtual	~MemoryPoolObject ()
void *	operator new (size_t s)
void	operator delete (void *p)
virtual MemoryPool *	getObjectMemoryPool ()=0

Detailed Description

A CrateTemplate is a ini defined set of conditions plus a ThingTemplate that is the Object containing the correct CrateCollide module.

Definition at line 55 of file CrateSystem.h.

Constructor & Destructor Documentation

CrateTemplate()

CrateTemplate::CrateTemplate

(

)

Definition at line 194 of file CrateSystem.cpp.

Member Function Documentation

getFieldParse()

const FieldParse * CrateTemplate::getFieldParse ( ) const

inline

Definition at line 66 of file CrateSystem.h.

getName()

AsciiString CrateTemplate::getName ( )

inline

Definition at line 64 of file CrateSystem.h.

parseCrateCreationEntry()

void CrateTemplate::parseCrateCreationEntry ( INI * ini, void * instance, void * store, const void *  )

static

Definition at line 211 of file CrateSystem.cpp.

setName()

void CrateTemplate::setName ( AsciiString name )

inline

Definition at line 63 of file CrateSystem.h.

Member Data Documentation

m_creationChance

Real CrateTemplate::m_creationChance

Condition for random percentage chance of creating.

Definition at line 73 of file CrateSystem.h.

m_isOwnedByMaker

Bool CrateTemplate::m_isOwnedByMaker

Design needs crates to be owned sometimes.

Definition at line 78 of file CrateSystem.h.

m_killedByTypeKindof

KindOfMaskType CrateTemplate::m_killedByTypeKindof

Must be killed by something with all these bits set.

Definition at line 75 of file CrateSystem.h.

m_killerScience

ScienceType CrateTemplate::m_killerScience

Must be killed by something posessing this science.

Definition at line 76 of file CrateSystem.h.

m_name

AsciiString CrateTemplate::m_name

name for this CrateTemplate

Definition at line 71 of file CrateSystem.h.

m_possibleCrates

crateCreationEntryList CrateTemplate::m_possibleCrates

CreationChance is for this CrateData to succeed, this list controls one-of-n crates created on success.

Definition at line 77 of file CrateSystem.h.

m_veterancyLevel

VeterancyLevel CrateTemplate::m_veterancyLevel

Condition specifing level of killed unit.

Definition at line 74 of file CrateSystem.h.

TheCrateTemplateFieldParseTable

const FieldParse CrateTemplate::TheCrateTemplateFieldParseTable

static

Initial value:

= 
{
    { "CreationChance",     INI::parseReal,                                                   NULL,                                   offsetof( CrateTemplate, m_creationChance ) },
    { "VeterancyLevel",     INI::parseIndexList,                                     TheVeterancyNames,     offsetof( CrateTemplate, m_veterancyLevel ) },
    { "KilledByType",           KindOfMaskType::parseFromINI,                                               NULL,                                   offsetof( CrateTemplate, m_killedByTypeKindof) },
    { "CrateObject",            CrateTemplate::parseCrateCreationEntry,   NULL,                                   NULL },
    { "KillerScience",      INI::parseScience,                                         NULL,                                   offsetof( CrateTemplate, m_killerScience) },
    { "OwnedByMaker",           INI::parseBool,                                                   NULL,                                   offsetof( CrateTemplate, m_isOwnedByMaker) },
    { NULL,                             NULL,                                                                       NULL,                                   NULL },     
}

the parse table for INI definition

Definition at line 183 of file CrateSystem.h.

---

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

• Code/GameEngine/Include/GameLogic/CrateSystem.h
• Code/GameEngine/Source/GameLogic/System/CrateSystem.cpp