Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

Ignore:
Timestamp:
May 30, 2010, 3:57:05 PM (14 years ago)
Author:
gnadler
Message:

documentation & formatting commit

File:
1 edited

Legend:

Unmodified
Added
Removed

  • code/branches/presentation3/src/modules/weapons/projectiles/SimpleRocket.h

    r7019 r7021  
    2727 */
    2828
     29    /**
     30    @file
     31    @brief
     32        SimpleRocket, follows direction from a Rocketcontroller, has fuel for 80% of its lifetime, afterwords it's fire disappears.
     33    @author
     34       Gabriel Nadler (Original file: Oli Scheuss)
     35    */
     36
     37
     38
    2939#ifndef _SimpleRocket_H__
    3040#define _SimpleRocket_H__
    … …  
    4050    class ConeCollisionShape;
    4151
    42     /**
    43     @brief
    44         SimpleRocket, that is made to move upon a specified pattern.
    45         This class was constructed for the PPS tutorial.
    46     @author
    47         Oli Scheuss
    48     */
     52
    4953    class _WeaponsExport SimpleRocket : public ControllableEntity
    5054    {
    … …  
    5862            void destroyObject();
    5963
    60             void disableFire();
     64            void disableFire(); //!< Method to disable the fire and stop all acceleration
    6165
    6266            virtual void moveFrontBack(const Vector2& value){}
    … …  
    112116            inline Pawn* getOwner() const
    113117                { return this->owner_; }
    114             inline bool hasFuel()
    115             { return this->fuel_;}
    116 
    117             inline void fuelRefill()
    118             {this->fuel_=true;}
     118            inline bool hasFuel() const
     119            { return this->fuel_; }
    119120
    120121            inline void setDamage(float damage)
    … …  
    128129            Vector3 localAngularVelocity_;
    129130            float damage_;
    130             bool bDestroy_;
    131             bool fuel_;
     131            bool bDestroy_; 
     132            bool fuel_; //!< Bool is true while the rocket "has fuel"
    132133
    133134
    … …  
    135136            Timer destroyTimer_;
    136137            float lifetime_;
    137             float maxLife_;
     138            static const int FUEL_PERCENTAGE=80; //!<Percentage of Lifetime the rocket has fuel
    138139
    139             ParticleEmitter* fire_;
     140            ParticleEmitter* fire_; //!< Fire-Emittor
    140141
    141142
Note: See TracChangeset for help on using the changeset viewer.