Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

Ignore:
Timestamp:
Apr 29, 2012, 3:42:22 PM (13 years ago)
Author:
mentzerf
Message:

Added readme file and reformatted some more

File:
1 edited

Legend:

Unmodified
Added
Removed

  • code/branches/newlevel2012/src/modules/towerdefense/TowerDefenseCenterpoint.h

    r9112 r9141  
    2828
    2929/**
    30     @file TowerDefenseCenterpoint.h
    31     @brief Declaration of the TowerDefenseCenterpoint class.
    32     @ingroup TowerDefense
    33 */
     30 @brief
     31 See TowerDefenseReadme.txt for Information.
     32 @ingroup TowerDefense
     33 */
     34
    3435
    3536#ifndef _TowerDefenseCenterpoint_H__
    … …  
    3940
    4041#include <string>
    41 
    4242#include <util/Math.h>
    4343
    … …  
    4646namespace orxonox
    4747{
    48    
    49     /**
    50     @brief
    51        
    52    
    53     @author
    54        
    55     @ingroup TowerDefense
    56     */
    5748    class _TowerDefenseExport TowerDefenseCenterpoint : public StaticEntity
    5849    {
    5950        public:
    60             TowerDefenseCenterpoint(BaseObject* creator); //!< Constructor. Registers and initializes the object and checks whether the gametype is actually TowerDefense.
     51            TowerDefenseCenterpoint(BaseObject* creator);
    6152            virtual ~TowerDefenseCenterpoint() {}
    6253
    63             virtual void XMLPort(Element& xmlelement, XMLPort::Mode mode); //!< Method to create a TowerDefenseCenterpoint through XML.
    64 
    65             virtual void changedGametype(); //!< Is called when the gametype has changed.
     54            virtual void XMLPort(Element& xmlelement, XMLPort::Mode mode);
     55            virtual void changedGametype();
    6656           
    6757            /**
    68             @brief Set the width of the playing field.
    69             @param width The width in number of tiles.
     58            @brief The width and hight in number of tiles. Default is 15 for both.
    7059            */
    7160            void setWidth(unsigned int width)
    7261                { this->width_ = width; }
    73             /**
    74             @brief Get the width of the playing field.
    75             @return Returns the width in number of tiles.
    76             */
    77             unsigned int getWidth(void) const
     62           
     63                        unsigned int getWidth(void) const
    7864                { return this->width_; }
    7965               
    80             /**
    81             @brief Set the height of the playing field.
    82             @param height The height in number of tiles.
    83             */
    8466            void setHeight(unsigned int height)
    8567                { this->height_ = height; }
    86             /**
    87             @brief Get the height of the playing field.
    88             @return Returns the height in number of tiles.
    89             */
    90             unsigned int getHeight(void) const
     68           
     69                        unsigned int getHeight(void) const
    9170                { return this->height_; }
    9271               
    … …  
    9776            void setTowerTemplate(const std::string& templateName)
    9877                { this->towerTemplate_ = templateName; }
    99             /**
    100             @brief Get the template for the towers.
    101             @return Returns the template name to be applied to each tower.
    102             */
    103             const std::string& getTowerTemplate(void) const
     78           
     79                        const std::string& getTowerTemplate(void) const
    10480                { return this->towerTemplate_; }
    105            
    10681
    10782        private:
    108             void checkGametype(); //!< Checks whether the gametype is TowerDefense and if it is, sets its centerpoint.
     83            void checkGametype();
    10984           
    11085            unsigned int width_;
    11186            unsigned int height_;
    11287            std::string towerTemplate_;
    113 
    11488    };
    11589}
Note: See TracChangeset for help on using the changeset viewer.