Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

Changeset 4836 in orxonox.OLD for orxonox/trunk/src/world_entities


Ignore:
Timestamp:
Jul 12, 2005, 12:33:16 AM (19 years ago)
Author:
bensch
Message:

orxonox/trunk: renamed all the \param → @param and so on in Doxygen tags.
Thanks a lot to the kDevelop team. this took since the last commit :)

Location:
orxonox/trunk/src/world_entities
Files:
28 edited

Legend:

Unmodified
Added
Removed

  • orxonox/trunk/src/world_entities/camera.cc

    r4832 r4836  
    3131
    3232/**
    33    \brief creates a Camera
     33 * creates a Camera
    3434*/
    3535Camera::Camera()
    … …  
    5353
    5454/**
    55    \brief default destructor
     55 * default destructor
    5656*/
    5757Camera::~Camera()
    … …  
    6161
    6262/**
    63    \brief focuses the Camera onto a Target
    64    \param target the new PNode the Camera should look at.
     63 * focuses the Camera onto a Target
     64 * @param target the new PNode the Camera should look at.
    6565*/
    6666void Camera::lookAt(PNode* target)
    … …  
    7070
    7171/**
    72    \returns The PNode of the Target (from there you can get position and so on
     72 * @returns The PNode of the Target (from there you can get position and so on
    7373*/
    7474PNode* Camera::getTarget()
    … …  
    7878
    7979/**
    80    \brief sets a new AspectRatio
    81    \param aspectRatio the new aspect ratio to set (width / height)
     80 * sets a new AspectRatio
     81 * @param aspectRatio the new aspect ratio to set (width / height)
    8282*/
    8383void Camera::setAspectRatio(float aspectRatio)
    … …  
    8787
    8888/**
    89    \brief sets the Field of View to fofy
    90    \param fovy new field of view factor (in degrees)
     89 * sets the Field of View to fofy
     90 * @param fovy new field of view factor (in degrees)
    9191*/
    9292void Camera::setFovy(float fovy)
    … …  
    9797/**
    9898  \brief Sets a new clipping region
    99   \param nearClip The near clip plane
    100   \param farClip The far clip plane
     99* @param nearClip The near clip plane
     100* @param farClip The far clip plane
    101101*/
    102102void Camera::setClipRegion(float nearClip, float farClip)
    … …  
    107107
    108108/**
    109    \brief sets the new VideoMode and initializes iteration to it.
    110    \param mode the mode to change to.
     109 * sets the new VideoMode and initializes iteration to it.
     110 * @param mode the mode to change to.
    111111*/
    112112void Camera::setViewMode(ViewMode mode)
    … …  
    143143
    144144/**
    145    \brief Updates the position of the camera.
    146    \param dt: The time that elapsed.
     145 * Updates the position of the camera.
     146 * @param dt: The time that elapsed.
    147147*/
    148148void Camera::tick(float dt)
    … …  
    161161
    162162/**
    163    \brief initialize rendering perspective according to this camera
     163 * initialize rendering perspective according to this camera
    164164
    165165   This is called immediately before the rendering cycle starts, it sets all global
    … …  
    194194
    195195/**
    196    \brief processes an event
    197    \param event: the event to process
     196 * processes an event
     197 * @param event: the event to process
    198198*/
    199199void Camera::process(const Event &event)

  • orxonox/trunk/src/world_entities/camera.h

    r4746 r4836  
    11/*!
    22    \file camera.h
    3     \brief Viewpoint controlling class definitions
     3  * Viewpoint controlling class definitions
    44*/
    55

  • orxonox/trunk/src/world_entities/character_attributes.cc

    r4320 r4836  
    2424
    2525/**
    26    \brief standard constructor
    27    \todo this constructor is not jet implemented - do it
     26 * standard constructor
     27   @todo this constructor is not jet implemented - do it
    2828*/
    2929CharacterAttributes::CharacterAttributes ()
    … …  
    3434
    3535/**
    36    \brief standard deconstructor
     36 * standard deconstructor
    3737
    3838*/
    … …  
    4545
    4646/**
    47    \brief sets the health of the character
    48    \param helath
     47 * sets the health of the character
     48 * @param helath
    4949 */
    5050void CharacterAttributes::setHealth(int health)
    … …  
    5454
    5555/**
    56    \brief adds health to the charater
    57    \param health
    58    \returns health that couldnt be added due to healt limit, 0 if everything worked as normal
     56 * adds health to the charater
     57 * @param health
     58 * @returns health that couldnt be added due to healt limit, 0 if everything worked as normal
    5959 */
    6060int CharacterAttributes::addHealth(int health)
    … …  
    7171
    7272/**
    73    \brief remove health due to damager for example
    74    \param amount of health
    75    \returns false if health is zero -> dead
     73 * remove health due to damager for example
     74 * @param amount of health
     75 * @returns false if health is zero -> dead
    7676 */
    7777bool CharacterAttributes::substractHealth(int health)
    … …  
    8787
    8888/**
    89    \brief gets the current amount of health
    90    \returns health
     89 * gets the current amount of health
     90 * @returns health
    9191 */
    9292int CharacterAttributes::getHealth()
    … …  
    9797
    9898/**
    99    \brief sets maximum health
    100    \param health
     99 * sets maximum health
     100 * @param health
    101101
    102102   if healthMax = 0 -> unlimited
    … …  
    108108
    109109/**
    110    \brief gets health maximium
    111    \returns the health maximum
     110 * gets health maximium
     111 * @returns the health maximum
    112112 */
    113113int CharacterAttributes::getHealthMax()
    … …  
    119119/*======================armor/ shields===================== */
    120120/**
    121    \brief sets the shild strength
    122    \param strength
     121 * sets the shild strength
     122 * @param strength
    123123 */
    124124void CharacterAttributes::setShieldStrength(int shieldStrength)
    … …  
    128128
    129129/**
    130    \brief adds shield strength
    131    \param strength
     130 * adds shield strength
     131 * @param strength
    132132   
    133133   there is currently no limit to shieldstrength
    … …  
    139139
    140140/**
    141    \brief substracts shield strength
    142    \param strength
    143    \returns amount of shield strength below zero after substraction. Magic: Troumble. if everything works allright, it returns 0
     141 * substracts shield strength
     142 * @param strength
     143 * @returns amount of shield strength below zero after substraction. Magic: Troumble. if everything works allright, it returns 0
    144144 */
    145145int CharacterAttributes::substractShieldStrength(int shieldStrength)
    … …  
    155155
    156156/**
    157    \brief gets shield strength
    158    \returns the shield strength
     157 * gets shield strength
     158 * @returns the shield strength
    159159 */
    160160int CharacterAttributes::getShieldStrength()
    … …  
    166166/*=====================damage=====================*/
    167167/**
    168    \brief sets the amount of base damage dealt to all aircrafts
    169    \param damage
     168 * sets the amount of base damage dealt to all aircrafts
     169 * @param damage
    170170
    171171   There can be a difference between arms that hit a ground/air craft. Eg.
    … …  
    179179
    180180/**
    181    \brief gets the amount of base damage
    182    \returns base damage to aircrafts
     181 * gets the amount of base damage
     182 * @returns base damage to aircrafts
    183183
    184184   There can be a difference between arms that hit a ground/air craft. Eg.
    … …  
    193193
    194194/**
    195    \brief sets the amount of base damage dealt to all groundcrafts
    196    \param damage
     195 * sets the amount of base damage dealt to all groundcrafts
     196 * @param damage
    197197
    198198   There can be a difference between arms that hit a ground/air craft. Eg.
    … …  
    206206
    207207/**
    208    \briefgets the amount of base damage
    209    \returns base damage to groundcrafts
     208 * gets the amount of base damage
     209 * @returns base damage to groundcrafts
    210210
    211211   There can be a difference between arms that hit a ground/air craft. Eg.
    … …  
    220220
    221221/**
    222    \brief sets the damage modifier to the damage that is dealed via laser weapons
    223    \param modifier [0..1]
     222 * sets the damage modifier to the damage that is dealed via laser weapons
     223 * @param modifier [0..1]
    224224
    225225   eg. the damage is calculated after: damage = modifier * damageToGroundCraft
    … …  
    231231
    232232/**
    233    \brief gets the damage modifier to the damage that is dealed via laser weapons
    234    \returns damage modifier
     233 * gets the damage modifier to the damage that is dealed via laser weapons
     234 * @returns damage modifier
    235235
    236236   eg. the damage is calculated after: damage = modifier * damageToGroundCraft
    … …  
    243243
    244244/**
    245    \brief sets the damage modifier to the damage that is dealed via plasma weapons
    246    \param damage modifier
     245 * sets the damage modifier to the damage that is dealed via plasma weapons
     246 * @param damage modifier
    247247
    248248   eg. the damage is calculated after: damage = modifier * damageToGroundCraft
    … …  
    254254
    255255/**
    256    \brief gets the damage modifier to the damage that is dealed plasma weapons
    257    \returns damage modifier
     256 * gets the damage modifier to the damage that is dealed plasma weapons
     257 * @returns damage modifier
    258258
    259259   eg. the damage is calculated after: damage = modifier * damageToGroundCraft
    … …  
    266266
    267267/**
    268    \brief sets the damage modifier to the damage that is dealed via explosives
    269    \param damage modifier
     268 * sets the damage modifier to the damage that is dealed via explosives
     269 * @param damage modifier
    270270
    271271   eg. the damage is calculated after: damage = modifier * damageToGroundCraft
    … …  
    277277
    278278/**
    279    \brief sets the damage modifier to the damage that is dealed via explosives
    280    \returns damage modifier
     279 * sets the damage modifier to the damage that is dealed via explosives
     280 * @returns damage modifier
    281281
    282282   eg. the damage is calculated after: damage = modifier * damageToGroundCraft
    … …  
    290290/*=====================energy=====================*/
    291291/**
    292    \brief sets the amount of energy
    293    \param energy
     292 * sets the amount of energy
     293 * @param energy
    294294 */
    295295void CharacterAttributes::setEnergy(int energy)
    … …  
    299299
    300300/**
    301    \brief adds energy to the system
    302    \param amount of energy
    303    \returns amount of energy that is too much due to energy limit
     301 * adds energy to the system
     302 * @param amount of energy
     303 * @returns amount of energy that is too much due to energy limit
    304304 */
    305305int CharacterAttributes::addEnergy(int addEnergy)
    … …  
    316316
    317317/**
    318    \brief substracts energy from a system
    319    \param amount of energy
    320    \returns false if there is no energy anymore
     318 * substracts energy from a system
     319 * @param amount of energy
     320 * @returns false if there is no energy anymore
    321321 */
    322322bool CharacterAttributes::substractEnergy(int subEnergy)
    … …  
    332332
    333333/**
    334    \brief gets the amount of energy
    335    \returns energy
     334 * gets the amount of energy
     335 * @returns energy
    336336 */
    337337int CharacterAttributes::getEnergy()
    … …  
    342342
    343343/**
    344    \brief sets the energy consumption
    345    \param amount of energy
     344 * sets the energy consumption
     345 * @param amount of energy
    346346*/
    347347void CharacterAttributes::setEnergyConsumption(int energy)
    … …  
    351351
    352352/**
    353    \brief gets the energy consumption
    354    \returns amount of energy
     353 * gets the energy consumption
     354 * @returns amount of energy
    355355*/
    356356int CharacterAttributes::getEnergyConsumption()
    … …  
    361361
    362362/**
    363    \brief sets the maximum energy level
    364    \param amount of energy
     363 * sets the maximum energy level
     364 * @param amount of energy
    365365*/
    366366void CharacterAttributes::setEnergyMax(int energy)
    … …  
    370370
    371371/**
    372    \brief gets the max energy level
    373    \returns amount of energy
     372 * gets the max energy level
     373 * @returns amount of energy
    374374*/
    375375int CharacterAttributes::getEnergyMax()

  • orxonox/trunk/src/world_entities/character_attributes.h

    r3583 r4836  
    11/*!
    22    \file character_attributes.h
    3     \brief Definition of the attributes of a character (healt, armor,.. ) whatever is important to the character
     3  * Definition of the attributes of a character (healt, armor,.. ) whatever is important to the character
    44*/
    55

  • orxonox/trunk/src/world_entities/environment.cc

    r4724 r4836  
    2828
    2929/**
    30    \brief creates an environment
     30 * creates an environment
    3131*/
    3232Environment::Environment () : WorldEntity()
    … …  
    4040
    4141/**
    42    \brief deletes an environment
     42 * deletes an environment
    4343*/
    4444Environment::~Environment ()
    … …  
    4848
    4949/**
    50    \brief ticks the environment
    51    \param time the time about which to tick
     50 * ticks the environment
     51 * @param time the time about which to tick
    5252*/
    5353void Environment::tick (float time) {}
    5454
    5555/**
    56    \brief if a hit occures
     56 * if a hit occures
    5757*/
    5858void Environment::hit (WorldEntity* weapon, Vector* loc) {}
    5959
    6060/**
    61    \brief destroys an Environment
     61 * destroys an Environment
    6262*/
    6363void Environment::destroy () {}
    6464
    6565/**
    66    \brief a collision with some ship
     66 * a collision with some ship
    6767*/
    6868void Environment::collide (WorldEntity* other,  Uint32 ownhitflags, Uint32 otherhitflags) {}
    6969
    7070/**
    71    \brief draws the Environment
     71 * draws the Environment
    7272*/
    7373void Environment::draw ()

  • orxonox/trunk/src/world_entities/player.cc

    r4834 r4836  
    4141
    4242/**
    43    \brief creates a new Player
    44    \param isFree if the player is free
     43 * creates a new Player
     44 * @param isFree if the player is free
    4545*/
    4646Player::Player()
    … …  
    6565
    6666/**
    67    \brief destructs the player, deletes alocated memory
     67 * destructs the player, deletes alocated memory
    6868*/
    6969Player::~Player ()
    … …  
    7878
    7979/**
    80    \brief creates a new Player from Xml Data
    81    \param root the xml element containing player data
    82 
    83    \todo add more parameters to load
     80 * creates a new Player from Xml Data
     81 * @param root the xml element containing player data
     82
     83   @todo add more parameters to load
    8484*/
    8585Player::Player(const TiXmlElement* root)
    … …  
    132132
    133133/**
    134    \brief adds a weapon to the weapon list of player
    135    \param weapon to add
     134 * adds a weapon to the weapon list of player
     135 * @param weapon to add
    136136*/
    137137void Player::addWeapon(Weapon* weapon)
    … …  
    142142
    143143/**
    144    \brief removes a weapon from the player
    145    \param weapon to remove
     144 * removes a weapon from the player
     145 * @param weapon to remove
    146146*/
    147147void Player::removeWeapon(Weapon* weapon)
    … …  
    152152
    153153/**
    154    \brief effect that occurs after the player is spawned
     154 * effect that occurs after the player is spawned
    155155*/
    156156void Player::postSpawn ()
    … …  
    161161
    162162/**
    163    \brief the action occuring if the player left the game
     163 * the action occuring if the player left the game
    164164*/
    165165void Player::leftWorld ()
    … …  
    169169
    170170/**
    171    \brief if the player is hit, call this function
    172    \param weapon hit by this weapon
    173    \param loc ??
     171 * if the player is hit, call this function
     172 * @param weapon hit by this weapon
     173 * @param loc ??
    174174*/
    175175void Player::hit (WorldEntity* weapon, Vector* loc)
    … …  
    179179
    180180/**
    181     \brief Collision with another Entity has this effect
    182     \param other the other colider
    183     \param ownhitflags ??
    184     \param otherhitflags ??
     181  * Collision with another Entity has this effect
     182  * @param other the other colider
     183  * @param ownhitflags ??
     184  * @param otherhitflags ??
    185185*/
    186186void Player::collide (WorldEntity* other, Uint32 ownhitflags, Uint32 otherhitflags)
    … …  
    190190
    191191/**
    192    \brief draws the player after transforming him.
     192 * draws the player after transforming him.
    193193*/
    194194void Player::draw ()
    … …  
    214214
    215215/**
    216    \brief the function called for each passing timeSnap
    217    \param time The timespan passed since last update
     216 * the function called for each passing timeSnap
     217 * @param time The timespan passed since last update
    218218*/
    219219void Player::tick (float time)
    … …  
    234234
    235235/**
    236    \brief action if player moves
    237    \param time the timeslice since the last frame
     236 * action if player moves
     237 * @param time the timeslice since the last frame
    238238*/
    239239void Player::move (float time)
    … …  
    256256    accel = accel + (orthDirection*acceleration);
    257257  if( this->bAscend )
    258   if( this->bDescend) {/* FIXME */} /* \todo up and down player movement */
     258  if( this->bDescend) {/* FIXME */} /* @todo up and down player movement */
    259259
    260260  Vector move = accel * time;
    … …  
    264264
    265265/**
    266    \brief weapon manipulation by the player
     266 * weapon manipulation by the player
    267267*/
    268268void Player::weapon()
    … …  
    281281
    282282/**
    283    \brief The connection to the command node
    284    \param cmd the Command unit from witch to map
     283 * The connection to the command node
     284 * @param cmd the Command unit from witch to map
    285285
    286286   here the commands are mapped to the players movement/weaponary

  • orxonox/trunk/src/world_entities/player.h

    r4834 r4836  
    11/*!
    22    \file player.h
    3     \brief Implements a basic controllable WorldEntity
     3  * Implements a basic controllable WorldEntity
    44 */
    55

  • orxonox/trunk/src/world_entities/power_up.h

    r3544 r4836  
    11/*!
    22    \file power_up.h
    3     \brief A class representing a PowerUp in the world.
     3  * A class representing a PowerUp in the world.
    44*/
    55

  • orxonox/trunk/src/world_entities/satellite.cc

    r4597 r4836  
    2727
    2828/**
    29    \brief standard constructor
     29 * standard constructor
    3030*/
    3131Satellite::Satellite (Vector axis, float speed)
    … …  
    4040
    4141/**
    42    \brief standard destructor
     42 * standard destructor
    4343*/
    4444Satellite::~Satellite ()
    … …  
    5151
    5252/**
    53    \brief this method is called every frame
    54    \param time: the time in seconds that has passed since the last tick
     53 * this method is called every frame
     54 * @param time: the time in seconds that has passed since the last tick
    5555
    5656   Handle all stuff that should update with time inside this method (movement, animation, etc.)
    … …  
    6868
    6969/**
    70    \brief the entity is drawn onto the screen with this function
     70 * the entity is drawn onto the screen with this function
    7171
    7272   This is a central function of an entity: call it to let the entity painted to the screen. Just override this function with whatever you want to be drawn.

  • orxonox/trunk/src/world_entities/satellite.h

    r4597 r4836  
    11/*!
    22    \file world_entity.h
    3     \brief Definition of the basic WorldEntity
     3  * Definition of the basic WorldEntity
    44*/
    55

  • orxonox/trunk/src/world_entities/skybox.cc

    r4746 r4836  
    3434
    3535/**
    36    \brief Constructs a SkyBox and takes fileName as a map.
    37    \param fileName the file to take as input for the SkyBox
     36 * Constructs a SkyBox and takes fileName as a map.
     37 * @param fileName the file to take as input for the SkyBox
    3838*/
    3939SkyBox::SkyBox(const char* fileName)
    … …  
    4646
    4747/**
    48    \brief initializes a skybox from a XmlElement
     48 * initializes a skybox from a XmlElement
    4949*/
    5050SkyBox::SkyBox(const TiXmlElement* root)
    … …  
    9393
    9494/**
    95    \brief default destructor
     95 * default destructor
    9696*/
    9797SkyBox::~SkyBox()
    … …  
    104104
    105105/**
    106    \brief sets A set of textures when just giving a Name and an extension:
     106 * sets A set of textures when just giving a Name and an extension:
    107107
    108108   usage: give this function an argument like
    … …  
    140140
    141141/**
    142    \brief Defines which textures should be loaded onto the SkyBox.
    143    \param top the top texture.
    144    \param bottom the bottom texture.
    145    \param left the left texture.
    146    \param right the right texture.
    147    \param front the front texture.
    148    \param back the back texture.
     142 * Defines which textures should be loaded onto the SkyBox.
     143 * @param top the top texture.
     144 * @param bottom the bottom texture.
     145 * @param left the left texture.
     146 * @param right the right texture.
     147 * @param front the front texture.
     148 * @param back the back texture.
    149149*/
    150150void SkyBox::setTextures(const char* top, const char* bottom, const char* left, const char* right, const char* front, const char* back)
    … …  
    159159
    160160/**
    161    \param size The new size of the SkyBox
     161 * @param size The new size of the SkyBox
    162162
    163163 * do not forget to rebuild the SkyBox after this.
    … …  
    169169
    170170/**
    171    \brief draws the SkyBox
     171 * draws the SkyBox
    172172*/
    173173void SkyBox::draw()
    … …  
    185185
    186186/**
    187    \brief rebuilds the SkyBox
     187 * rebuilds the SkyBox
    188188
    189189   this must be done, when changing the Size of the Skybox (runtime-efficency)

  • orxonox/trunk/src/world_entities/skybox.h

    r4746 r4836  
    11/*!
    22    \file skybox.h
    3     \brief Definition of the SkyBox, that handles the Display of an atmosphere for orxonox.
     3  * Definition of the SkyBox, that handles the Display of an atmosphere for orxonox.
    44
    55    A SkyBox is always centered at the current working Camera, and will only obey the cameras

  • orxonox/trunk/src/world_entities/skysphere.cc

    r4597 r4836  
    3838
    3939/**
    40    \brief Constructs a SkySphere and takes fileName as a map.
    41    \param fileName the file to take as input for the skysphere
     40 * Constructs a SkySphere and takes fileName as a map.
     41 * @param fileName the file to take as input for the skysphere
    4242*/
    4343Skysphere::Skysphere(char* fileName)
    … …  
    5353
    5454/**
    55    \brief default destructor
     55 * default destructor
    5656*/
    5757Skysphere::~Skysphere()
    … …  
    6363
    6464/**
    65    \brief initializes the Skysphere.
    66    \param fileName the file to take as input for the skysphere
     65 * initializes the Skysphere.
     66 * @param fileName the file to take as input for the skysphere
    6767*/
    6868void Skysphere::initialize(char* fileName)
    … …  
    8383
    8484/**
    85    \brief Defines which texture should be loaded onto the skysphere.
    86    \param fileName The filename of the Texture
     85 * Defines which texture should be loaded onto the skysphere.
     86 * @param fileName The filename of the Texture
    8787*/
    8888void Skysphere::setTexture(char* fileName)
    … …  
    9393
    9494/**
    95    \brief draws the Skysphere
     95 * draws the Skysphere
    9696
    9797   This part is normally precessed in the "Painting Phase".
    … …  
    115115
    116116/**
    117    \brief sets the Radius of the Sphere.
    118    \param radius The Radius of The Sphere
     117 * sets the Radius of the Sphere.
     118 * @param radius The Radius of The Sphere
    119119*/
    120120void Skysphere::setRadius(float radius)

  • orxonox/trunk/src/world_entities/skysphere.h

    r4597 r4836  
    11/*!
    22    \file skysphere.h
    3     \brief Definition of the Skysphere, that handles the Display of an atmosphere of orxonox.
     3  * Definition of the Skysphere, that handles the Display of an atmosphere of orxonox.
    44
    55    A SkySphere is always centered at the current working Camera, and will only obey the cameras
    66    movment but not its rotation.
    77
    8     \todo self-rotation
    9     \todo handle reference to parent-object
     8    @todo self-rotation
     9    @todo handle reference to parent-object
    1010*/
    1111

  • orxonox/trunk/src/world_entities/terrain.cc

    r4746 r4836  
    2929
    3030/**
    31    \brief standard constructor
     31 * standard constructor
    3232
    3333*/
    … …  
    3939
    4040/**
    41    \brief Constructor for loading a Terrain out of a file
    42    \param fileName The file to load data from.
     41 * Constructor for loading a Terrain out of a file
     42 * @param fileName The file to load data from.
    4343
    4444   this either loads out of an OBJ-file, or loads a heightmap if no .obj-extension is found.
    … …  
    5959
    6060/**
    61    \brief a Constructor for the Debug-Worlds
    62 
    63    \todo make it not compileable when not in debug-mode
     61 * a Constructor for the Debug-Worlds
     62
     63   @todo make it not compileable when not in debug-mode
    6464*/
    6565Terrain::Terrain(DebugTerrain debugTerrain)
    … …  
    7070
    7171/**
    72    \brief standard deconstructor
     72 * standard deconstructor
    7373
    7474*/

  • orxonox/trunk/src/world_entities/terrain.h

    r4746 r4836  
    11/*!
    22    \file terrain.h
    3     \brief Defines and handles the terrain of the World
     3  * Defines and handles the terrain of the World
    44
    5     \todo implement it
     5    @todo implement it
    66
    77    The terrain should either be build from a Model a OBJModel or from a HeightMap.

  • orxonox/trunk/src/world_entities/weapons/crosshair.h

    r4832 r4836  
    11/*!
    22    \file crosshair.h
    3     \brief Definition of ...
     3  * Definition of ...
    44
    55*/

  • orxonox/trunk/src/world_entities/weapons/projectile.cc

    r4758 r4836  
    2929
    3030/**
    31    \brief standard constructor
     31 * standard constructor
    3232*/
    3333Projectile::Projectile (Weapon* weapon) : WorldEntity()
    … …  
    4444
    4545/**
    46    \brief standard deconstructor
     46 * standard deconstructor
    4747*/
    4848Projectile::~Projectile ()
    … …  
    5757
    5858/**
    59    \brief this sets the flight direction of the projectile
    60    \param directin in which to flight
     59 * this sets the flight direction of the projectile
     60 * @param directin in which to flight
    6161
    6262   this function will calculate a vector out of this to be used in the
    … …  
    7474
    7575/**
    76    \brief this sets the time to life of the projectile
    77    \param ttl in second
     76 * this sets the time to life of the projectile
     77 * @param ttl in second
    7878
    7979   after this life time, the projectile will garbage collect itself
    … …  
    8686
    8787/**
    88    \brief sets the speed of the projectile
     88 * sets the speed of the projectile
    8989*/
    9090void Projectile::setSpeed(float speed)
    … …  
    9696
    9797/**
    98    \brief sets the velocity vector to a spec speed
    99    \param velocity: vector of the velocity
     98 * sets the velocity vector to a spec speed
     99 * @param velocity: vector of the velocity
    100100*/
    101101void Projectile::setVelocity(const Vector &velocity)
    … …  
    108108
    109109/**
    110    \brief signal tick, time dependent things will be handled here
    111    \param time since last tick
     110 * signal tick, time dependent things will be handled here
     111 * @param time since last tick
    112112*/
    113113void Projectile::tick (float time)
    … …  
    128128
    129129/**
    130    \brief the projectile gets hit by another entity
    131    \param the other entity
    132    \param place where it is hit
     130 * the projectile gets hit by another entity
     131 * @param the other entity
     132 * @param place where it is hit
    133133*/
    134134void Projectile::hit (WorldEntity* entity, Vector* place)
    … …  
    137137
    138138/**
    139    \brief the function gets called, when the projectile is destroyed
     139 * the function gets called, when the projectile is destroyed
    140140*/
    141141void Projectile::destroy ()

  • orxonox/trunk/src/world_entities/weapons/projectile.h

    r4758 r4836  
    11/*!
    22    \projectile.h
    3     \brief a projectile, that is been shooted by a weapon
     3  * a projectile, that is been shooted by a weapon
    44
    55    You can use this class to make some shoots, but this isn't the real idea. If you want to just test, if the

  • orxonox/trunk/src/world_entities/weapons/test_bullet.cc

    r4758 r4836  
    2929
    3030/**
    31    \brief standard constructor
     31 * standard constructor
    3232*/
    3333TestBullet::TestBullet (Weapon* weapon) : Projectile(weapon)
    … …  
    4141
    4242/**
    43    \brief standard deconstructor
     43 * standard deconstructor
    4444*/
    4545TestBullet::~TestBullet ()
    … …  
    5555
    5656/**
    57    \brief signal tick, time dependent things will be handled here
    58    \param time since last tick
     57 * signal tick, time dependent things will be handled here
     58 * @param time since last tick
    5959*/
    6060void TestBullet::tick (float time)
    … …  
    7676
    7777/**
    78    \brief the projectile gets hit by another entity
    79    \param the other entity
    80    \param place where it is hit
     78 * the projectile gets hit by another entity
     79 * @param the other entity
     80 * @param place where it is hit
    8181*/
    8282void TestBullet::hit (WorldEntity* entity, Vector* place)
    … …  
    8585
    8686/**
    87    \brief the function gets called, when the projectile is destroyed
     87 * the function gets called, when the projectile is destroyed
    8888*/
    8989void TestBullet::destroy ()

  • orxonox/trunk/src/world_entities/weapons/test_bullet.h

    r4758 r4836  
    11/*!
    22    \projectile.h
    3     \brief a projectile, that is been shooted by a weapon
     3  * a projectile, that is been shooted by a weapon
    44*/
    55

  • orxonox/trunk/src/world_entities/weapons/test_gun.cc

    r4829 r4836  
    1616
    1717
    18    \todo: direction in which the projectile flights
    19    \todo: a target to set/hit
     18   @todo: direction in which the projectile flights
     19   @todo: a target to set/hit
    2020*/
    2121
    … …  
    3939
    4040/**
    41    \brief standard constructor
     41 * standard constructor
    4242
    4343   creates a new weapon
    … …  
    103103
    104104/**
    105    \brief standard deconstructor
     105 * standard deconstructor
    106106*/
    107107TestGun::~TestGun ()
    … …  
    112112
    113113/**
    114    \brief this activates the weapon
     114 * this activates the weapon
    115115
    116116   This is needed, since there can be more than one weapon on a ship. the
    … …  
    125125
    126126/**
    127    \brief this deactivates the weapon
     127 * this deactivates the weapon
    128128
    129129   This is needed, since there can be more than one weapon on a ship. the
    … …  
    138138
    139139/**
    140    \brief fires the weapon
     140 * fires the weapon
    141141
    142142   this is called from the player.cc, when fire-button is been pushed
    143    \todo: the ObjectManager deliveres Projectiles not TestBullets! this should be diffrent
     143   @todo: the ObjectManager deliveres Projectiles not TestBullets! this should be diffrent
    144144*/
    145145void TestGun::fire()
    … …  
    165165
    166166/**
    167    \brief is called, when the weapon gets hit (=collide with something)
    168    \param from which entity it is been hit
    169    \param where it is been hit
     167 * is called, when the weapon gets hit (=collide with something)
     168 * @param from which entity it is been hit
     169 * @param where it is been hit
    170170
    171171   this may not be used, since it would make the game relay complicated when one
    … …  
    177177
    178178/**
    179    \brief is called, when the weapon is destroyed
     179 * is called, when the weapon is destroyed
    180180
    181181   this is in conjunction with the hit function, so when a weapon is able to get
    … …  
    187187
    188188/**
    189    \brief tick signal for time dependent/driven stuff
     189 * tick signal for time dependent/driven stuff
    190190*/
    191191void TestGun::tick (float time)
    … …  
    196196
    197197/**
    198    \brief is called, when there is no fire button pressed
     198 * is called, when there is no fire button pressed
    199199*/
    200200void TestGun::weaponIdle()
    … …  
    203203
    204204/**
    205    \brief this will draw the weapon
     205 * this will draw the weapon
    206206*/
    207207void TestGun::draw ()

  • orxonox/trunk/src/world_entities/weapons/test_gun.h

    r4827 r4836  
    11/*!
    22    \file weapon.h
    3     \brief a weapon that a player can use
     3  * a weapon that a player can use
    44
    55    A Player has a list of weapons, that can be choosen to shoot projectiles

  • orxonox/trunk/src/world_entities/weapons/weapon.cc

    r4834 r4836  
    2525
    2626/**
    27    \brief standard constructor
     27 * standard constructor
    2828
    2929   creates a new weapon
    … …  
    3838
    3939/**
    40    \brief standard deconstructor
     40 * standard deconstructor
    4141*/
    4242Weapon::~Weapon ()
    … …  
    5252
    5353/**
    54     \brief enables the weapon
     54  * enables the weapon
    5555
    5656    a weapon can be enabled/disabled because of various reasons. if a weapon is
    … …  
    6565
    6666/**
    67     \brief disables the weapon
     67  * disables the weapon
    6868
    6969    a weapon can be enabled/disabled because of various reasons. if a weapon is
    … …  
    7878
    7979/**
    80     \brief checks if the weapon is enabled
    81     \returns true if enabled
     80  * checks if the weapon is enabled
     81  * @returns true if enabled
    8282
    8383    a weapon can be ebabled/disabled because of various reasons. if a weapon is
    … …  
    9292
    9393/**
    94    \brief sets a new projectile to the weapon
    95    \param new projectile for this weapon
     94 * sets a new projectile to the weapon
     95 * @param new projectile for this weapon
    9696
    9797   weapon an projectile are independent, so you can combine them as you want
    … …  
    104104
    105105/**
    106    \brief sets a new projectile to the weapon
    107    \returns the current projectile of this weapon
     106 * sets a new projectile to the weapon
     107 * @returns the current projectile of this weapon
    108108
    109109   weapon an projectile are independent, so you can combine them as you want
    … …  
    116116
    117117/**
    118    \brief this activates the weapon
     118 * this activates the weapon
    119119
    120120   This is needed, since there can be more than one weapon on a ship. the
    … …  
    127127
    128128/**
    129    \brief this deactivates the weapon
     129 * this deactivates the weapon
    130130
    131131   This is needed, since there can be more than one weapon on a ship. the
    … …  
    137137
    138138/**
    139    \brief asks if the current weapon is active
    140    \returns true if it the weapon is active
     139 * asks if the current weapon is active
     140 * @returns true if it the weapon is active
    141141*/
    142142bool Weapon::isActive()
    … …  
    149149
    150150/**
    151    \brief is called, when the weapon gets hit (=collide with something)
    152    \param from which entity it is been hit
    153    \param where it is been hit
     151 * is called, when the weapon gets hit (=collide with something)
     152 * @param from which entity it is been hit
     153 * @param where it is been hit
    154154
    155155   this may not be used, since it would make the game relay complicated when one
    … …  
    161161
    162162/**
    163    \brief is called, when the weapon is destroyed
     163 * is called, when the weapon is destroyed
    164164
    165165   this is in conjunction with the hit function, so when a weapon is able to get
    … …  
    171171
    172172/**
    173    \brief tick signal for time dependent/driven stuff
     173 * tick signal for time dependent/driven stuff
    174174*/
    175175void Weapon::tick (float time)
    … …  
    178178
    179179/**
    180    \brief is called, when there is no fire button pressed
     180 * is called, when there is no fire button pressed
    181181*/
    182182void Weapon::weaponIdle()
    … …  
    185185
    186186/**
    187    \brief this will draw the weapon
     187 * this will draw the weapon
    188188*/
    189189void Weapon::draw ()

  • orxonox/trunk/src/world_entities/weapons/weapon.h

    r4832 r4836  
    11/*!
    22    \file weapon.h
    3     \brief a weapon that a  can use
     3  * a weapon that a  can use
    44
    55
    … …  
    9797  inline bool hasWeaponIdleTimeElapsed() const { return (this->localTime>this->idleTime)?true:false; };
    9898
    99   /** @brief fires the weapon */
     99  /** fires the weapon */
    100100  virtual void fire() = 0;
    101101  virtual void hit (WorldEntity* weapon, const Vector& loc);

  • orxonox/trunk/src/world_entities/weapons/weapon_manager.h

    r4834 r4836  
    11/*!
    22    \file weapon.h
    3     \brief a weapon that a player can use
     3  * a weapon that a player can use
    44
    55    A Player has a list of weapons, that can be choosen to shoot projectiles

  • orxonox/trunk/src/world_entities/world_entity.cc

    r4814 r4836  
    2626
    2727/**
    28    \brief Loads the WordEntity-specific Part of any derived Class
     28 * Loads the WordEntity-specific Part of any derived Class
    2929*/
    3030WorldEntity::WorldEntity(const TiXmlElement* root)
    … …  
    4242
    4343/**
    44    \brief standard destructor
     44 * standard destructor
    4545*/
    4646WorldEntity::~WorldEntity ()
    … …  
    6262
    6363/**
    64    \brief loads a Model onto a WorldEntity
    65    \param fileName the name of the model to load
     64 * loads a Model onto a WorldEntity
     65 * @param fileName the name of the model to load
    6666*/
    6767void WorldEntity::loadModel(const char* fileName)
    … …  
    7979
    8080/**
    81    \brief sets the character attributes of a worldentity
    82    \param character attributes
     81 * sets the character attributes of a worldentity
     82 * @param character attributes
    8383
    8484   these attributes don't have to be set, only use them, if you need them
    … …  
    8989
    9090/**
    91    \brief gets the Character attributes of this worldentity
    92    \returns character attributes
     91 * gets the Character attributes of this worldentity
     92 * @returns character attributes
    9393*/
    9494CharacterAttributes* WorldEntity::getCharacterAttributes()
    … …  
    9797
    9898/**
    99    \brief set the WorldEntity's collision hull
    100    \param newhull: a pointer to a completely assembled CollisionCluster
     99 * set the WorldEntity's collision hull
     100 * @param newhull: a pointer to a completely assembled CollisionCluster
    101101
    102102   Any previously assigned collision hull will be deleted on reassignment
    … …  
    113113
    114114/**
    115     \brief process draw function
     115  * process draw function
    116116*/
    117117void WorldEntity::processDraw ()
    … …  
    121121
    122122/**
    123    \brief sets the drawable state of this entity.
    124    \param bDraw TRUE if draweable, FALSE otherwise
     123 * sets the drawable state of this entity.
     124 * @param bDraw TRUE if draweable, FALSE otherwise
    125125*/
    126126void WorldEntity::setDrawable (bool bDraw)
    … …  
    131131
    132132/**
    133    \brief this function is called, when two entities collide
    134    \param entity: the world entity with whom it collides
     133 * this function is called, when two entities collide
     134 * @param entity: the world entity with whom it collides
    135135
    136136   Implement behaviour like damage application or other miscellaneous collision stuff in this function
    … …  
    143143
    144144/**
    145    \brief this function is called, when the ship is hit by a waepon
    146    \param weapon: the laser/rocket/shoot that hits.
    147    \param loc: place where it is hit
     145 * this function is called, when the ship is hit by a waepon
     146 * @param weapon: the laser/rocket/shoot that hits.
     147 * @param loc: place where it is hit
    148148
    149149   calculate the damage depending
    … …  
    153153
    154154/**
    155    \brief this is called immediately after the Entity has been constructed and initialized
     155 * this is called immediately after the Entity has been constructed and initialized
    156156
    157157   Put any initialisation code that requires knowledge of location (placement if the Entity is free) and owner of the entity here.
    … …  
    164164
    165165/**
    166    \brief this method is called by the world if the WorldEntity leaves valid gamespace
     166 * this method is called by the world if the WorldEntity leaves valid gamespace
    167167
    168168   For free entities this means it left the Track boundaries. With bound entities it means its Location adresses a
    … …  
    175175
    176176/**
    177    \brief this method is called every frame
    178    \param time: the time in seconds that has passed since the last tick
     177 * this method is called every frame
     178 * @param time: the time in seconds that has passed since the last tick
    179179
    180180   Handle all stuff that should update with time inside this method (movement, animation, etc.)
    … …  
    186186
    187187/**
    188    \brief the entity is drawn onto the screen with this function
     188 * the entity is drawn onto the screen with this function
    189189
    190190   This is a central function of an entity: call it to let the entity painted to the screen. Just override this function with whatever you want to be drawn.
    … …  
    230230
    231231/**
    232    \brief this handles incoming command messages
    233    \param cmd: a pointer to the incoming Command structure
     232 * this handles incoming command messages
     233 * @param cmd: a pointer to the incoming Command structure
    234234
    235235   Put all code that handles Command messages here, this will mainly be called by the assigned CommandNode but can also be used

  • orxonox/trunk/src/world_entities/world_entity.h

    r4746 r4836  
    11/*!
    22    \file world_entity.h
    3     \brief Definition of the basic WorldEntity
     3  * Definition of the basic WorldEntity
    44*/
    55
    … …  
    5050  virtual void command (Command* cmd);
    5151
    52   /** \returns the Count of Faces on this WorldEntity */
     52  /** @returns the Count of Faces on this WorldEntity */
    5353  virtual unsigned int getFaceCount () const { if (this->model) return this->model->getFaceCount(); else return 0; };
    5454
Note: See TracChangeset for help on using the changeset viewer.