DtFireForEffectOnEntityTask Class Reference

DtFireForEffectOnEntityTask represents an artillery task to fire for effect on the specified entity. More...

Inheritance diagram for DtFireForEffectOnEntityTask:

List of all members.

Public Member Functions
	DtFireForEffectOnEntityTask ()
	default constructor
	DtFireForEffectOnEntityTask (const DtString &writeName, DtReaderWriterRegistry *parentRegistry=0)
	constructor If you have a task 'put' itself, the writeName will preface the task.
	DtFireForEffectOnEntityTask (const DtString &writeName, const DtFireForEffectOnEntityTask &orig, DtReaderWriterRegistry *parentRegistry=0)
	copy constructor
const DtFireForEffectOnEntityTask &	operator= (const DtFireForEffectOnEntityTask &orig)
	assignment operator
virtual	~DtFireForEffectOnEntityTask ()
virtual int	type () const
	Override to define the type of FFE task; types found in taskNames.h.
virtual DtSimTask *	clone (const DtString &name, DtReaderWriterRegistry *parentRegistry=0) const
	Creates a copy of this FFE task.
virtual DtString	stringRep () const
	Get a readable string representation of this task.
virtual void	setEntityName (const DtString &entityName)
	Set location.
virtual const DtString &	entityName () const
	Get location.
virtual int	netRepSize () const
	Returns the size of the full network representation padded to an 8-byte boundary.
virtual bool	setFromNet (const char *contentBuffer, unsigned contentSize)
	Fills in the task from the network buffer.
virtual bool	setToNet ()
	Fills in the network buffer (created by base class simTask) with the task contents.
Static Public Member Functions
static DtSimTask *	creator ()
Protected Attributes
DtRwString	myEntityName

---

Detailed Description

DtFireForEffectOnEntityTask represents an artillery task to fire for effect on the specified entity.

---

Constructor & Destructor Documentation

DtFireForEffectOnEntityTask::DtFireForEffectOnEntityTask

(

)

default constructor

DtFireForEffectOnEntityTask::DtFireForEffectOnEntityTask	(	const DtString &	writeName,
		DtReaderWriterRegistry *	parentRegistry = 0
	)

constructor If you have a task 'put' itself, the writeName will preface the task.

DtFireForEffectOnEntityTask::DtFireForEffectOnEntityTask	(	const DtString &	writeName,
		const DtFireForEffectOnEntityTask &	orig,
		DtReaderWriterRegistry *	parentRegistry = 0
	)

copy constructor

virtual DtFireForEffectOnEntityTask::~DtFireForEffectOnEntityTask

(

)

[virtual]

---

Member Function Documentation

const DtFireForEffectOnEntityTask& DtFireForEffectOnEntityTask::operator=

(

const DtFireForEffectOnEntityTask &

orig

)

assignment operator

virtual int DtFireForEffectOnEntityTask::type

(

)

const [virtual]

Override to define the type of FFE task; types found in taskNames.h.

Implements DtSimTask.

virtual DtSimTask* DtFireForEffectOnEntityTask::clone	(	const DtString &	name,
		DtReaderWriterRegistry *	parentRegistry = 0
	)		const [virtual]

Creates a copy of this FFE task.

Implements DtSimTask.

virtual DtString DtFireForEffectOnEntityTask::stringRep

(

)

const [virtual]

Get a readable string representation of this task.

Implements DtSimTask.

virtual void DtFireForEffectOnEntityTask::setEntityName

(

const DtString &

entityName

)

[virtual]

Set location.

virtual const DtString& DtFireForEffectOnEntityTask::entityName

(

)

const [virtual]

Get location.

virtual int DtFireForEffectOnEntityTask::netRepSize

(

)

const [virtual]

Returns the size of the full network representation padded to an 8-byte boundary.

Reimplemented from DtFireForEffectTask.

virtual bool DtFireForEffectOnEntityTask::setFromNet	(	const char *	contentBuffer,
		unsigned	contentSize
	)		[virtual]

Fills in the task from the network buffer.

Reimplemented from DtFireForEffectTask.

virtual bool DtFireForEffectOnEntityTask::setToNet

(

)

[virtual]

Fills in the network buffer (created by base class simTask) with the task contents.

Reimplemented from DtFireForEffectTask.

static DtSimTask* DtFireForEffectOnEntityTask::creator

(

)

[static]

---

Member Data Documentation

DtRwString DtFireForEffectOnEntityTask::myEntityName [protected]

---

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

• include/vrftasks/ffeEntity.h