ScriptGroup Class Reference

#include <Scripts.h>

Inherits MemoryPoolObject, and Snapshot.

Public Member Functions
	ScriptGroup ()
ScriptGroup *	duplicate (void) const
ScriptGroup *	duplicateAndQualify (const AsciiString &qualifier, const AsciiString &playerTemplateName, const AsciiString &newPlayerName) const
void	setName (AsciiString name)
void	setActive (Bool active)
void	setSubroutine (Bool subr)
void	setWarnings (Bool warnings)
void	setNextGroup (ScriptGroup *pGr)
AsciiString	getName (void) const
Bool	isActive (void) const
Bool	isSubroutine (void) const
Bool	hasWarnings (void) const
ScriptGroup *	getNext (void) const
Script *	getScript (void)
void	addScript (Script *pScr, Int ndx)
void	deleteScript (Script *pScr)
Public Member Functions inherited from MemoryPoolObject
void	deleteInstance ()
Public Member Functions inherited from Snapshot
	Snapshot (void)
	~Snapshot (void)

Static Public Member Functions
static void	WriteGroupDataChunk (DataChunkOutput &chunkWriter, ScriptGroup *pGroup)
static Bool	ParseGroupDataChunk (DataChunkInput &file, DataChunkInfo *info, void *userData)

Protected Member Functions
virtual void	crc (Xfer *xfer)
virtual void	xfer (Xfer *xfer)
virtual void	loadPostProcess (void)
Protected Member Functions inherited from MemoryPoolObject
virtual	~MemoryPoolObject ()
void *	operator new (size_t s)
void	operator delete (void *p)
virtual MemoryPool *	getObjectMemoryPool ()=0

Protected Attributes
Script *	m_firstScript
AsciiString	m_groupName
Bool	m_isGroupActive
Bool	m_isGroupSubroutine
ScriptGroup *	m_nextGroup
Bool	m_hasWarnings
	Runtime flag used by the editor only.

Detailed Description

Definition at line 105 of file Scripts.h.

Constructor & Destructor Documentation

ScriptGroup()

ScriptGroup::ScriptGroup

(

void

)

Ctor - gives it a default name.

Definition at line 641 of file Scripts.cpp.

Member Function Documentation

addScript()

void ScriptGroup::addScript	(	Script *	pScr,
		Int	ndx )

Add a script to the current list of scripts. Offset to position ndx.

Definition at line 839 of file Scripts.cpp.

crc()

void ScriptGroup::crc ( Xfer * xfer )

protectedvirtual

CRC

Implements Snapshot.

Definition at line 681 of file Scripts.cpp.

deleteScript()

void ScriptGroup::deleteScript

(

Script *

pScr

)

Delete a script from the current list of scripts.

Definition at line 816 of file Scripts.cpp.

duplicate()

ScriptGroup * ScriptGroup::duplicate

(

void

)

const

ScriptGroup::duplicate - Creates a full, "deep" copy of ScriptGroup. m_nextGroup is NULL on the copy.

Definition at line 748 of file Scripts.cpp.

duplicateAndQualify()

ScriptGroup * ScriptGroup::duplicateAndQualify	(	const AsciiString &	qualifier,
		const AsciiString &	playerTemplateName,
		const AsciiString &	newPlayerName ) const

ScriptGroup::duplicateAndQualify - Creates a full, "deep" copy of ScriptGroup, adding qualifier to names. m_nextGroup is NULL on the copy.

Definition at line 782 of file Scripts.cpp.

getName()

AsciiString ScriptGroup::getName ( void ) const

inline

Definition at line 141 of file Scripts.h.

getNext()

ScriptGroup * ScriptGroup::getNext ( void ) const

inline

Definition at line 145 of file Scripts.h.

getScript()

Script * ScriptGroup::getScript ( void )

inline

Definition at line 146 of file Scripts.h.

hasWarnings()

Bool ScriptGroup::hasWarnings ( void ) const

inline

Definition at line 144 of file Scripts.h.

isActive()

Bool ScriptGroup::isActive ( void ) const

inline

Definition at line 142 of file Scripts.h.

isSubroutine()

Bool ScriptGroup::isSubroutine ( void ) const

inline

Definition at line 143 of file Scripts.h.

loadPostProcess()

void ScriptGroup::loadPostProcess ( void )

protectedvirtual

Load post process

Implements Snapshot.

Definition at line 739 of file Scripts.cpp.

ParseGroupDataChunk()

Bool ScriptGroup::ParseGroupDataChunk ( DataChunkInput & file, DataChunkInfo * info, void * userData )

static

ScriptGroup::ParseGroupDataChunk - read a Group chunk. Format is the newer CHUNKY format. See ScriptList::WriteScriptListDataChunk for the writer. Input: DataChunkInput

Definition at line 889 of file Scripts.cpp.

setActive()

void ScriptGroup::setActive ( Bool active )

inline

Definition at line 136 of file Scripts.h.

setName()

void ScriptGroup::setName ( AsciiString name )

inline

Definition at line 135 of file Scripts.h.

setNextGroup()

void ScriptGroup::setNextGroup ( ScriptGroup * pGr )

inline

Definition at line 139 of file Scripts.h.

setSubroutine()

void ScriptGroup::setSubroutine ( Bool subr )

inline

Definition at line 137 of file Scripts.h.

setWarnings()

void ScriptGroup::setWarnings ( Bool warnings )

inline

Definition at line 138 of file Scripts.h.

WriteGroupDataChunk()

void ScriptGroup::WriteGroupDataChunk ( DataChunkOutput & chunkWriter, ScriptGroup * pGroup )

static

ScriptGroup::WriteGroupDataChunk - Writes a Scripts chunk. Format is the newer CHUNKY format. Input: DataChunkInput

Definition at line 866 of file Scripts.cpp.

xfer()

void ScriptGroup::xfer ( Xfer * xfer )

protectedvirtual

Xfer method Version Info: 1: Initial version 2: m_isGroupActive, since it is twiddled by other scripts. Only its initial state is determined by the map.

Implements Snapshot.

Definition at line 693 of file Scripts.cpp.

Member Data Documentation

m_firstScript

Script* ScriptGroup::m_firstScript

protected

Definition at line 118 of file Scripts.h.

m_groupName

AsciiString ScriptGroup::m_groupName

protected

Definition at line 119 of file Scripts.h.

m_hasWarnings

Bool ScriptGroup::m_hasWarnings

protected

Runtime flag used by the editor only.

Definition at line 123 of file Scripts.h.

m_isGroupActive

Bool ScriptGroup::m_isGroupActive

protected

Definition at line 120 of file Scripts.h.

m_isGroupSubroutine

Bool ScriptGroup::m_isGroupSubroutine

protected

Definition at line 121 of file Scripts.h.

m_nextGroup

ScriptGroup* ScriptGroup::m_nextGroup

protected

Definition at line 122 of file Scripts.h.

---

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

• Code/GameEngine/Include/GameLogic/Scripts.h
• Code/GameEngine/Source/GameLogic/ScriptEngine/Scripts.cpp