[6552] | 1 | /* |
---|
| 2 | * ORXONOX - the hottest 3D action shooter ever to exist |
---|
| 3 | * > www.orxonox.net < |
---|
| 4 | * |
---|
| 5 | * |
---|
| 6 | * License notice: |
---|
| 7 | * |
---|
| 8 | * This program is free software; you can redistribute it and/or |
---|
| 9 | * modify it under the terms of the GNU General Public License |
---|
| 10 | * as published by the Free Software Foundation; either version 2 |
---|
| 11 | * of the License, or (at your option) any later version. |
---|
| 12 | * |
---|
| 13 | * This program is distributed in the hope that it will be useful, |
---|
| 14 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
---|
| 15 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
---|
| 16 | * GNU General Public License for more details. |
---|
| 17 | * |
---|
| 18 | * You should have received a copy of the GNU General Public License |
---|
| 19 | * along with this program; if not, write to the Free Software |
---|
| 20 | * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. |
---|
| 21 | * |
---|
| 22 | * Author: |
---|
[6574] | 23 | * Eric Beier |
---|
[6552] | 24 | * Co-authors: |
---|
| 25 | * ... |
---|
| 26 | * |
---|
| 27 | */ |
---|
[6681] | 28 | |
---|
| 29 | /** |
---|
| 30 | @file SpeedPickup.cc |
---|
| 31 | @brief Implementation of the SpeedPickup class. |
---|
| 32 | */ |
---|
| 33 | |
---|
| 34 | #include "SpeedPickup.h" |
---|
| 35 | |
---|
| 36 | #include "core/CoreIncludes.h" |
---|
| 37 | #include "core/XMLPort.h" |
---|
| 38 | #include "util/StringUtils.h" |
---|
| 39 | |
---|
| 40 | #include "worldentities/pawns/SpaceShip.h" |
---|
| 41 | #include "items/Engine.h" |
---|
| 42 | #include "pickup/PickupIdentifier.h" |
---|
| 43 | |
---|
| 44 | #include <sstream> |
---|
| 45 | |
---|
| 46 | |
---|
| 47 | namespace orxonox |
---|
| 48 | { |
---|
| 49 | CreateFactory(SpeedPickup); |
---|
| 50 | |
---|
| 51 | /** |
---|
| 52 | @brief |
---|
| 53 | Constructor. Registers the object and initializes the member variables. |
---|
| 54 | */ |
---|
| 55 | SpeedPickup::SpeedPickup(BaseObject* creator) : Pickup(creator) |
---|
| 56 | { |
---|
| 57 | RegisterObject(SpeedPickup); |
---|
| 58 | |
---|
| 59 | this->initialize(); |
---|
| 60 | } |
---|
| 61 | |
---|
| 62 | /** |
---|
| 63 | @brief |
---|
| 64 | Destructor. |
---|
| 65 | */ |
---|
| 66 | SpeedPickup::~SpeedPickup() |
---|
| 67 | { |
---|
| 68 | |
---|
| 69 | } |
---|
| 70 | |
---|
| 71 | /** |
---|
| 72 | @brief |
---|
| 73 | Initializes the member variables. |
---|
| 74 | */ |
---|
| 75 | void SpeedPickup::initialize(void) |
---|
| 76 | { |
---|
[6706] | 77 | this->duration_ = 0.0f; |
---|
| 78 | this->speedAdd_ = 0.0f; |
---|
| 79 | this->speedMultiply_ = 1.0f; |
---|
[6681] | 80 | |
---|
[6713] | 81 | this->addTarget(ClassIdentifier<Engine>::getIdentifier()); |
---|
[6681] | 82 | } |
---|
| 83 | |
---|
| 84 | /** |
---|
| 85 | @brief |
---|
| 86 | Initializes the PickupIdentifier of this pickup. |
---|
| 87 | */ |
---|
| 88 | void SpeedPickup::initializeIdentifier(void) |
---|
| 89 | { |
---|
| 90 | std::stringstream stream; |
---|
| 91 | stream << this->getDuration(); |
---|
| 92 | std::string type1 = "duration"; |
---|
| 93 | std::string val1 = stream.str(); |
---|
| 94 | this->pickupIdentifier_->addParameter(type1, val1); |
---|
| 95 | |
---|
| 96 | stream.clear(); |
---|
| 97 | stream << this->getSpeedAdd(); |
---|
| 98 | std::string type2 = "speedAdd"; |
---|
| 99 | std::string val2 = stream.str(); |
---|
| 100 | this->pickupIdentifier_->addParameter(type2, val2); |
---|
| 101 | |
---|
| 102 | stream.clear(); |
---|
| 103 | stream << this->getSpeedMultiply(); |
---|
| 104 | std::string type3 = "speedMultiply"; |
---|
| 105 | std::string val3 = stream.str(); |
---|
| 106 | this->pickupIdentifier_->addParameter(type3, val3); |
---|
| 107 | } |
---|
| 108 | |
---|
| 109 | /** |
---|
| 110 | @brief |
---|
| 111 | Method for creating a SpeedPickup object through XML. |
---|
| 112 | */ |
---|
| 113 | void SpeedPickup::XMLPort(Element& xmlelement, orxonox::XMLPort::Mode mode) |
---|
| 114 | { |
---|
| 115 | SUPER(SpeedPickup, XMLPort, xmlelement, mode); |
---|
| 116 | |
---|
| 117 | XMLPortParam(SpeedPickup, "duration", setDuration, getDuration, xmlelement, mode); |
---|
| 118 | XMLPortParam(SpeedPickup, "speedAdd", setSpeedAdd, getSpeedAdd, xmlelement, mode); |
---|
| 119 | XMLPortParam(SpeedPickup, "speedMultiply", setSpeedMultiply, getSpeedMultiply, xmlelement, mode); |
---|
| 120 | |
---|
| 121 | this->initializeIdentifier(); |
---|
| 122 | } |
---|
| 123 | |
---|
| 124 | /** |
---|
| 125 | @brief |
---|
| 126 | Is called when the pickup has transited from used to unused or the other way around. |
---|
| 127 | */ |
---|
| 128 | void SpeedPickup::changedUsed(void) |
---|
| 129 | { |
---|
| 130 | SUPER(SpeedPickup, changedUsed); |
---|
| 131 | |
---|
| 132 | //! If the pickup is not picked up nothing must be done. |
---|
| 133 | if(!this->isPickedUp()) |
---|
| 134 | return; |
---|
| 135 | |
---|
[6706] | 136 | Engine* engine = this->carrierToEngineHelper(); |
---|
| 137 | if(engine == NULL) //!< If the PickupCarrier is no Engine, then this pickup is useless and therefore is destroyed. |
---|
| 138 | this->destroy(); |
---|
| 139 | |
---|
[6681] | 140 | //! If the pickup has transited to used. |
---|
| 141 | if(this->isUsed()) |
---|
| 142 | { |
---|
[6694] | 143 | this->startPickupTimer(this->getDuration()); |
---|
[6681] | 144 | engine->setSpeedAdd(this->getSpeedAdd()); |
---|
| 145 | engine->setSpeedMultiply(this->getSpeedMultiply()); |
---|
| 146 | } |
---|
[6706] | 147 | else |
---|
| 148 | { |
---|
| 149 | engine->setSpeedAdd(0.0f); |
---|
| 150 | engine->setSpeedMultiply(1.0f); |
---|
| 151 | |
---|
| 152 | if(this->isOnce()) |
---|
| 153 | { |
---|
| 154 | this->destroy(); |
---|
| 155 | } |
---|
| 156 | } |
---|
[6681] | 157 | } |
---|
| 158 | |
---|
| 159 | /** |
---|
| 160 | @brief |
---|
| 161 | Helper to transform the PickupCarrier to a Pawn, and throw an error message if the conversion fails. |
---|
| 162 | @return |
---|
| 163 | A pointer to the Pawn, or NULL if the conversion failed. |
---|
| 164 | */ |
---|
| 165 | Engine* SpeedPickup::carrierToEngineHelper(void) |
---|
| 166 | { |
---|
| 167 | PickupCarrier* carrier = this->getCarrier(); |
---|
[6713] | 168 | Engine* engine = dynamic_cast<Engine*>(carrier); |
---|
[6681] | 169 | |
---|
[6713] | 170 | if(engine == NULL) |
---|
[6681] | 171 | { |
---|
| 172 | COUT(1) << "Invalid PickupCarrier in SpeedPickup." << std::endl; |
---|
| 173 | } |
---|
[6713] | 174 | |
---|
| 175 | return engine; |
---|
[6681] | 176 | } |
---|
| 177 | |
---|
| 178 | /** |
---|
| 179 | @brief |
---|
| 180 | Creates a duplicate of the input OrxonoxClass. |
---|
| 181 | @param item |
---|
| 182 | A pointer to the Orxonox class. |
---|
| 183 | */ |
---|
| 184 | void SpeedPickup::clone(OrxonoxClass*& item) |
---|
| 185 | { |
---|
| 186 | if(item == NULL) |
---|
| 187 | item = new SpeedPickup(this); |
---|
| 188 | |
---|
| 189 | SUPER(SpeedPickup, clone, item); |
---|
| 190 | |
---|
| 191 | SpeedPickup* pickup = dynamic_cast<SpeedPickup*>(item); |
---|
| 192 | pickup->setDuration(this->getDuration()); |
---|
| 193 | pickup->setSpeedAdd(this->getSpeedAdd()); |
---|
| 194 | pickup->setSpeedMultiply(this->getSpeedMultiply()); |
---|
| 195 | |
---|
| 196 | pickup->initializeIdentifier(); |
---|
| 197 | } |
---|
| 198 | |
---|
| 199 | /** |
---|
| 200 | @brief |
---|
| 201 | Sets the duration. |
---|
| 202 | @param duration |
---|
| 203 | The duration |
---|
| 204 | */ |
---|
| 205 | void SpeedPickup::setDuration(float duration) |
---|
| 206 | { |
---|
| 207 | if(duration >= 0.0f) |
---|
| 208 | { |
---|
| 209 | this->duration_ = duration; |
---|
| 210 | } |
---|
| 211 | else |
---|
| 212 | { |
---|
| 213 | COUT(1) << "Invalid duration in SpeedPickup." << std::endl; |
---|
[6694] | 214 | this->duration_ = 0.0f; |
---|
[6681] | 215 | } |
---|
| 216 | } |
---|
| 217 | |
---|
| 218 | /** |
---|
| 219 | @brief |
---|
| 220 | Sets the SpeedAdd |
---|
| 221 | @param speedAdd |
---|
| 222 | The added Speed |
---|
| 223 | */ |
---|
| 224 | void SpeedPickup::setSpeedAdd(float speedAdd) |
---|
| 225 | { |
---|
| 226 | if(speedAdd >= 0.0f) |
---|
| 227 | { |
---|
| 228 | this->speedAdd_ = speedAdd; |
---|
| 229 | } |
---|
| 230 | else |
---|
| 231 | { |
---|
| 232 | COUT(1) << "Invalid speedAdd in SpeedPickup." << std::endl; |
---|
[6694] | 233 | this->speedAdd_ = 0.0f; |
---|
[6681] | 234 | } |
---|
| 235 | } |
---|
| 236 | |
---|
| 237 | /** |
---|
| 238 | @brief |
---|
| 239 | Sets the SpeedMultiply |
---|
| 240 | @param speedAdd |
---|
| 241 | The multiplied Speed |
---|
| 242 | */ |
---|
| 243 | void SpeedPickup::setSpeedMultiply(float speedMultiply) |
---|
| 244 | { |
---|
| 245 | if(speedMultiply != 0) |
---|
| 246 | { |
---|
| 247 | this->speedMultiply_ = speedMultiply; |
---|
| 248 | } |
---|
| 249 | else |
---|
| 250 | { |
---|
| 251 | COUT(1) << "Invalid speedMultiply in SpeedPickup." << std::endl; |
---|
[6694] | 252 | this->speedMultiply_ = 1.0f; |
---|
[6681] | 253 | } |
---|
| 254 | } |
---|
| 255 | |
---|
[6706] | 256 | void SpeedPickup::pickupTimerCallback(void) |
---|
| 257 | { |
---|
| 258 | this->setUsed(false); |
---|
[6681] | 259 | } |
---|
| 260 | } |
---|