vrforces5.2/classref/fire_for_effect_task_8h_source.html

 /*******************************************************************************

 ** Copyright (c) 2021 MAK Technologies, Inc.

 ** All rights reserved.

 *******************************************************************************/


 #pragma once


 #include <vlutil/vlMachineTypes.h>


 #include "vrftasks/simTask.h"

 #include <readerWriter/rwString.h>

 #include "vrfutil/rwResource.h"

 #include <readerWriter/rwInt.h>

 #include <readerWriter/rwReal.h>

 #include <readerWriter/rwBoolean.h>

 #include "vrfutil/rwTaitBryan.h"


 #include "vrftasks/vrftasksDefines.h"

 class DT_DLL_vrftasks DtFireForEffectTask : public DtSimTask

 {


 protected:

    DtFireForEffectTask();


    DtFireForEffectTask(const DtString & writeName, DtReaderWriterRegistry *

       parentRegistry = nullptr);


    DtFireForEffectTask(const DtString & writeName, const DtFireForEffectTask &

       orig, DtReaderWriterRegistry * parentRegistry = nullptr);


    const DtFireForEffectTask & operator=(const DtFireForEffectTask & orig);


 public:

    virtual ~DtFireForEffectTask() override;


    virtual void addWeapon(const DtString& weap);

    virtual const DtRwStringList& weaponNames() const;

    virtual DtRwStringList& weaponNames();

    virtual void setWeaponNames(const DtRwStringList& weapons);


    virtual bool getWeaponOnList(const DtString& weaponName, DtString& weapon) const;


    virtual void setWeaponId(const DtString& weaponId);

    virtual DtString weaponId() const;

    virtual bool weaponIdSpecified() const;


    virtual void setAmmoType(const DtEntityType& ammoType);

    virtual const DtEntityType& ammoType() const;

    virtual bool ammoTypeSpecified() const;


    //virtual void setAmmoTypeSpecified(bool specified);

    //virtual bool ammoTypeSpecified() const;


    virtual void setNumberOfRounds(int rounds);

    virtual int numberOfRounds() const;

    virtual bool numberOfRoundsSpecified() const;


    virtual void setDispersionRadius(DtReal radius);

    virtual DtReal dispersionRadius() const;

    virtual bool dispersionRadiusSpecified() const;


    virtual void setHeightAboveTerrain(DtReal height);

    virtual DtReal heightAboveTerrain() const;

    virtual bool heightAboveTerrainSpecified() const;


    virtual void setMuzzleSpeed(DtReal v);

    virtual DtReal muzzleSpeed() const;

    virtual bool muzzleSpeedSpecified() const;


    virtual void setMuzzleOrientation(DtTaitBryan & orient);

    virtual const DtRwTaitBryan & muzzleOrientation() const;

    virtual bool muzzleOrientationSpecified() const;


    virtual void setFuseType(int i);

    virtual bool fuseTypeSpecified() const;

    virtual DtDetonatorFuze fuseType() const;


    virtual void setGenerateKnownTargetPoint(bool);

    virtual bool generateKnownTargetPoint() const;


    virtual void setKnownTargetPointName(const DtString&);

    virtual const DtString& knownTargetPointName() const;


    virtual void setContinuousFire(bool);

    virtual bool continuousFire() const;


    virtual void setFireMissionIndex(unsigned int);

    virtual unsigned int fireMissionIndex() const;


    virtual int netRepSize() const override;


    virtual bool setFromNet(const char* contentBuffer,

       unsigned contentSize) override;


    virtual void postGetSelf() override;


    virtual bool setToNet() override;


    virtual DtString parameterStringRep() const;


 protected:

    DtRwStringList myWeaponNames;


    DtRwInt        myNumberOfRounds;

    DtRwReal       myDispersionRadius;

    DtRwReal       myHeightAboveTerrain;

    DtRwInt        myFuseType;

    DtRwInt      myFireMissionIndex;


    DtRwReal       myMuzzleSpeed;

    DtRwTaitBryan  myMuzzleOrientation;


    DtRwBoolean myGenerateKnownTargetPoint;


    DtRwString myKnownTargetPointName;


    DtRwBoolean myContinuousFire;


    DtRwString myWeaponId;


    DtRwResource myAmmoType;

 };


DtFireForEffectTask::myContinuousFire
DtRwBoolean myContinuousFire
Whether or not the firing will be continuous until a cease fire task is received. ...
Definition: fireForEffectTask.h:183

DtFireForEffectTask::myMuzzleSpeed
DtRwReal myMuzzleSpeed
In some circumstances like a hand tossed grenade the user may want to temper the force with which the...
Definition: fireForEffectTask.h:172

DtFireForEffectTask::myFuseType
DtRwInt myFuseType
Definition: fireForEffectTask.h:167

rwInt.h

DtFireForEffectTask::myAmmoType
DtRwResource myAmmoType
Indicates the ammo type to be fired.
Definition: fireForEffectTask.h:190

DtFireForEffectTask::myMuzzleOrientation
DtRwTaitBryan myMuzzleOrientation
Definition: fireForEffectTask.h:173

DtReaderWriter::postGetSelf
virtual void postGetSelf()
Called after either version of getSelf (mtl or environment). Default is no-op.

DtFireForEffectTask::myWeaponId
DtRwString myWeaponId
Weapon ID string for the weapon that should be used. Replaces myWeaponNames in VRF 5...
Definition: fireForEffectTask.h:187

DtFireForEffectTask::myHeightAboveTerrain
DtRwReal myHeightAboveTerrain
Definition: fireForEffectTask.h:166

rwBoolean.h

DtRwString
Description: Readable, Writable DtString Variable substitutions are done on this object when it is re...
Definition: rwString.h:20

DtRwTaitBryan
Description: Readable, Writable DtTaitBryan.
Definition: rwTaitBryan.h:20

DtReaderWriterRegistry
Definition: readerWriterRegistry.h:39

DtFireForEffectTask::myGenerateKnownTargetPoint
DtRwBoolean myGenerateKnownTargetPoint
On detonation create a known target point of first two letters of shooters name plus 4 random numbers...
Definition: fireForEffectTask.h:176

rwTaitBryan.h
Contains the DtRwTaitBryan class declaration.

DtFireForEffectTask::myKnownTargetPointName
DtRwString myKnownTargetPointName
If generating a known point, set this text to be the name of the known point rather than having the s...
Definition: fireForEffectTask.h:180

DtSimTask::setFromNet
virtual bool setFromNet(const char *contentBuffer, unsigned contentSize)
Sets mySubtask member from the incoming contentBuffer (cast to type DtNetSimTask). Derived classes should call down to this function first, and then extract their own data starting at the location contentBuffer + DtSimTask::netRepSize().

DtRwInt
Description: Readable, Writable int.
Definition: rwInt.h:25

DtSimTask::setToNet
virtual bool setToNet()
Calls netRep() to create the network buffer. Casts the resulting myNetRep to type DtNetSimTask*...

rwReal.h

DT_DLL_vrftasks
#define DT_DLL_vrftasks
This file is used to determine how to build.
Definition: vrftasksDefines.h:26

DtRwReal
Description: Readable, Writable DtReal (double)
Definition: rwReal.h:27

DtFireForEffectTask::myDispersionRadius
DtRwReal myDispersionRadius
Definition: fireForEffectTask.h:165

rwString.h

DtRwBoolean
Description: Readable, Writable bool.
Definition: rwBoolean.h:26

DtFireForEffectTask::myWeaponNames
DtRwStringList myWeaponNames
Definition: fireForEffectTask.h:162

DtSimTask
DtSimTask is an abstract base class from which real tasks can derive. It manages the read/write capab...
Definition: simTask.h:30

DtSimTask::operator=
const DtSimTask & operator=(const DtSimTask &orig)
assignment operator; same as copy constructor

DtFireForEffectTask::myNumberOfRounds
DtRwInt myNumberOfRounds
Definition: fireForEffectTask.h:164

DtRwStringList
Definition: rwStringList.h:20

DtFireForEffectTask::myFireMissionIndex
DtRwInt myFireMissionIndex
Definition: fireForEffectTask.h:168

DtString

rwResource.h

DtRwResource
This class will read in an old resource by name and convert it to the type, or, just read it as type...
Definition: rwResource.h:12

DtFireForEffectTask
File: fireForEff.h.
Definition: fireForEffectTask.h:32

vrftasksDefines.h

simTask.h

DtSimTask::netRepSize
virtual int netRepSize() const
Returns the size in bytes of the network representation of the class. This is the size in bytes of th...