VR-Forces 4.0.4 Class Documentation
Public Member Functions | Static Public Member Functions | Protected Attributes
DtFireAtTargetTask Class Reference

Task for firing at a target. More...

Inheritance diagram for DtFireAtTargetTask:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 DtFireAtTargetTask ()
 DtFireAtTargetTask (const DtString &writeName, DtReaderWriterRegistry *parentRegistry=0)
 constructor If you have a request 'put' itself, the writeName will preface it.
 DtFireAtTargetTask (const DtString &writeName, const DtFireAtTargetTask &orig, DtReaderWriterRegistry *parentRegistry=0)
 copy constructor
const DtFireAtTargetTaskoperator= (const DtFireAtTargetTask &orig)
 assignment operator
virtual ~DtFireAtTargetTask ()
virtual int type () const
 Returns DtFireWeaponTaskType.
virtual DtSimTaskclone (const DtString &name, DtReaderWriterRegistry *parentRegistry=0) const
 Creates a copy of the request.
virtual DtString stringRep () const
 Get a readable string representation of this setDataRequest.
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.
virtual const bool autoSelectWeapon () const
 Whether to auto-select the weapon to fire.
virtual void setAutoSelectWeapon (const bool autoSelect)
 Whether to auto-select the weapon to fire.
virtual const DtString weaponToFire () const
 The name of the weapon system to fire.
virtual void setWeaponToFire (const DtString weaponToFire)
 The name of the weapon system to fire.
virtual const DtString targetName () const
 The name of the target to fire upon.
virtual void setTargetName (const DtString target)
 The name of the target to fire upon.
virtual const int maxRoundsToFire () const
 The maximum number of rounds to fire.
virtual void setMaxRoundsToFire (const int maxRounds)
 The maximum number of rounds to fire.

Static Public Member Functions

static DtSimTaskcreator ()

Protected Attributes

DtRwBoolean myAutoSelectWeapon
DtRwString myWeaponToFire
DtRwString myTargetName
DtRwInt myMaxRoundsToFire

Detailed Description

Task for firing at a target.

Used to task an entity to fire a manually or automatically chosen weapon at a target.


Constructor & Destructor Documentation

DtFireAtTargetTask::DtFireAtTargetTask ( const DtString writeName,
DtReaderWriterRegistry parentRegistry = 0 
)

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

DtFireAtTargetTask::DtFireAtTargetTask ( const DtString writeName,
const DtFireAtTargetTask orig,
DtReaderWriterRegistry parentRegistry = 0 
)

copy constructor


Member Function Documentation

const DtFireAtTargetTask& DtFireAtTargetTask::operator= ( const DtFireAtTargetTask orig)

assignment operator

virtual int DtFireAtTargetTask::type ( ) const [virtual]

Returns DtFireWeaponTaskType.

Implements DtSimTask.

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

Creates a copy of the request.

Implements DtSimTask.

virtual DtString DtFireAtTargetTask::stringRep ( ) const [virtual]

Get a readable string representation of this setDataRequest.

Implements DtSimTask.

virtual const bool DtFireAtTargetTask::autoSelectWeapon ( ) const [virtual]

Whether to auto-select the weapon to fire.

If set to true weaponToFire will be ignored.

virtual void DtFireAtTargetTask::setAutoSelectWeapon ( const bool  autoSelect) [virtual]

Whether to auto-select the weapon to fire.

If set to true weaponToFire will be ignored.

virtual const DtString DtFireAtTargetTask::weaponToFire ( ) const [virtual]

The name of the weapon system to fire.

virtual void DtFireAtTargetTask::setWeaponToFire ( const DtString  weaponToFire) [virtual]

The name of the weapon system to fire.

virtual const DtString DtFireAtTargetTask::targetName ( ) const [virtual]

The name of the target to fire upon.

virtual void DtFireAtTargetTask::setTargetName ( const DtString  target) [virtual]

The name of the target to fire upon.

virtual const int DtFireAtTargetTask::maxRoundsToFire ( ) const [virtual]

The maximum number of rounds to fire.

Burst fire weapons may actually fire more rounds than this.

virtual void DtFireAtTargetTask::setMaxRoundsToFire ( const int  maxRounds) [virtual]

The maximum number of rounds to fire.

Burst fire weapons may actually fire more rounds than this.

virtual int DtFireAtTargetTask::netRepSize ( ) const [virtual]

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

Reimplemented from DtSimTask.

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

Fills in the task from the network buffer.

Reimplemented from DtSimTask.

virtual bool DtFireAtTargetTask::setToNet ( ) [virtual]

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

Reimplemented from DtSimTask.

static DtSimTask* DtFireAtTargetTask::creator ( ) [static]

Member Data Documentation


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

Document ID: Generated on Fri Jun 29 16:33:32 EDT 2012 from SVN revision 116588
Copyright © 2005-2012 VT MÄK Inc. All Rights Reserved (www.mak.com)