Changeset 4836 in orxonox.OLD for orxonox/trunk/src/world_entities/character_attributes.cc
- Timestamp:
- Jul 12, 2005, 12:33:16 AM (20 years ago)
-
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
- File:
-
- 1 edited
Legend:
- Unmodified
- Added
- Removed
-
orxonox/trunk/src/world_entities/character_attributes.cc
r4320 r4836 24 24 25 25 /** 26 \briefstandard constructor27 \todo this constructor is not jet implemented - do it26 * standard constructor 27 @todo this constructor is not jet implemented - do it 28 28 */ 29 29 CharacterAttributes::CharacterAttributes () … … 34 34 35 35 /** 36 \briefstandard deconstructor36 * standard deconstructor 37 37 38 38 */ … … 45 45 46 46 /** 47 \briefsets the health of the character48 \param helath47 * sets the health of the character 48 * @param helath 49 49 */ 50 50 void CharacterAttributes::setHealth(int health) … … 54 54 55 55 /** 56 \briefadds health to the charater57 \param health58 \returns health that couldnt be added due to healt limit, 0 if everything worked as normal56 * 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 59 59 */ 60 60 int CharacterAttributes::addHealth(int health) … … 71 71 72 72 /** 73 \briefremove health due to damager for example74 \param amount of health75 \returns false if health is zero -> dead73 * remove health due to damager for example 74 * @param amount of health 75 * @returns false if health is zero -> dead 76 76 */ 77 77 bool CharacterAttributes::substractHealth(int health) … … 87 87 88 88 /** 89 \briefgets the current amount of health90 \returns health89 * gets the current amount of health 90 * @returns health 91 91 */ 92 92 int CharacterAttributes::getHealth() … … 97 97 98 98 /** 99 \briefsets maximum health100 \param health99 * sets maximum health 100 * @param health 101 101 102 102 if healthMax = 0 -> unlimited … … 108 108 109 109 /** 110 \briefgets health maximium111 \returns the health maximum110 * gets health maximium 111 * @returns the health maximum 112 112 */ 113 113 int CharacterAttributes::getHealthMax() … … 119 119 /*======================armor/ shields===================== */ 120 120 /** 121 \briefsets the shild strength122 \param strength121 * sets the shild strength 122 * @param strength 123 123 */ 124 124 void CharacterAttributes::setShieldStrength(int shieldStrength) … … 128 128 129 129 /** 130 \briefadds shield strength131 \param strength130 * adds shield strength 131 * @param strength 132 132 133 133 there is currently no limit to shieldstrength … … 139 139 140 140 /** 141 \briefsubstracts shield strength142 \param strength143 \returns amount of shield strength below zero after substraction. Magic: Troumble. if everything works allright, it returns 0141 * 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 144 144 */ 145 145 int CharacterAttributes::substractShieldStrength(int shieldStrength) … … 155 155 156 156 /** 157 \briefgets shield strength158 \returns the shield strength157 * gets shield strength 158 * @returns the shield strength 159 159 */ 160 160 int CharacterAttributes::getShieldStrength() … … 166 166 /*=====================damage=====================*/ 167 167 /** 168 \briefsets the amount of base damage dealt to all aircrafts169 \param damage168 * sets the amount of base damage dealt to all aircrafts 169 * @param damage 170 170 171 171 There can be a difference between arms that hit a ground/air craft. Eg. … … 179 179 180 180 /** 181 \briefgets the amount of base damage182 \returns base damage to aircrafts181 * gets the amount of base damage 182 * @returns base damage to aircrafts 183 183 184 184 There can be a difference between arms that hit a ground/air craft. Eg. … … 193 193 194 194 /** 195 \briefsets the amount of base damage dealt to all groundcrafts196 \param damage195 * sets the amount of base damage dealt to all groundcrafts 196 * @param damage 197 197 198 198 There can be a difference between arms that hit a ground/air craft. Eg. … … 206 206 207 207 /** 208 \briefgets the amount of base damage209 \returns base damage to groundcrafts208 * gets the amount of base damage 209 * @returns base damage to groundcrafts 210 210 211 211 There can be a difference between arms that hit a ground/air craft. Eg. … … 220 220 221 221 /** 222 \briefsets the damage modifier to the damage that is dealed via laser weapons223 \param modifier [0..1]222 * sets the damage modifier to the damage that is dealed via laser weapons 223 * @param modifier [0..1] 224 224 225 225 eg. the damage is calculated after: damage = modifier * damageToGroundCraft … … 231 231 232 232 /** 233 \briefgets the damage modifier to the damage that is dealed via laser weapons234 \returns damage modifier233 * gets the damage modifier to the damage that is dealed via laser weapons 234 * @returns damage modifier 235 235 236 236 eg. the damage is calculated after: damage = modifier * damageToGroundCraft … … 243 243 244 244 /** 245 \briefsets the damage modifier to the damage that is dealed via plasma weapons246 \param damage modifier245 * sets the damage modifier to the damage that is dealed via plasma weapons 246 * @param damage modifier 247 247 248 248 eg. the damage is calculated after: damage = modifier * damageToGroundCraft … … 254 254 255 255 /** 256 \briefgets the damage modifier to the damage that is dealed plasma weapons257 \returns damage modifier256 * gets the damage modifier to the damage that is dealed plasma weapons 257 * @returns damage modifier 258 258 259 259 eg. the damage is calculated after: damage = modifier * damageToGroundCraft … … 266 266 267 267 /** 268 \briefsets the damage modifier to the damage that is dealed via explosives269 \param damage modifier268 * sets the damage modifier to the damage that is dealed via explosives 269 * @param damage modifier 270 270 271 271 eg. the damage is calculated after: damage = modifier * damageToGroundCraft … … 277 277 278 278 /** 279 \briefsets the damage modifier to the damage that is dealed via explosives280 \returns damage modifier279 * sets the damage modifier to the damage that is dealed via explosives 280 * @returns damage modifier 281 281 282 282 eg. the damage is calculated after: damage = modifier * damageToGroundCraft … … 290 290 /*=====================energy=====================*/ 291 291 /** 292 \briefsets the amount of energy293 \param energy292 * sets the amount of energy 293 * @param energy 294 294 */ 295 295 void CharacterAttributes::setEnergy(int energy) … … 299 299 300 300 /** 301 \briefadds energy to the system302 \param amount of energy303 \returns amount of energy that is too much due to energy limit301 * adds energy to the system 302 * @param amount of energy 303 * @returns amount of energy that is too much due to energy limit 304 304 */ 305 305 int CharacterAttributes::addEnergy(int addEnergy) … … 316 316 317 317 /** 318 \briefsubstracts energy from a system319 \param amount of energy320 \returns false if there is no energy anymore318 * substracts energy from a system 319 * @param amount of energy 320 * @returns false if there is no energy anymore 321 321 */ 322 322 bool CharacterAttributes::substractEnergy(int subEnergy) … … 332 332 333 333 /** 334 \briefgets the amount of energy335 \returns energy334 * gets the amount of energy 335 * @returns energy 336 336 */ 337 337 int CharacterAttributes::getEnergy() … … 342 342 343 343 /** 344 \briefsets the energy consumption345 \param amount of energy344 * sets the energy consumption 345 * @param amount of energy 346 346 */ 347 347 void CharacterAttributes::setEnergyConsumption(int energy) … … 351 351 352 352 /** 353 \briefgets the energy consumption354 \returns amount of energy353 * gets the energy consumption 354 * @returns amount of energy 355 355 */ 356 356 int CharacterAttributes::getEnergyConsumption() … … 361 361 362 362 /** 363 \briefsets the maximum energy level364 \param amount of energy363 * sets the maximum energy level 364 * @param amount of energy 365 365 */ 366 366 void CharacterAttributes::setEnergyMax(int energy) … … 370 370 371 371 /** 372 \briefgets the max energy level373 \returns amount of energy372 * gets the max energy level 373 * @returns amount of energy 374 374 */ 375 375 int CharacterAttributes::getEnergyMax()
Note: See TracChangeset
for help on using the changeset viewer.
