abstract_characteristic.hpp

//
//  SuperTuxKart - a fun racing game with go-kart
//  Copyright (C) 2006-2015 SuperTuxKart-Team
//
//  This program is free software; you can redistribute it and/or
//  modify it under the terms of the GNU General Public License
//  as published by the Free Software Foundation; either version 3
//  of the License, or (at your option) any later version.
//
//  This program is distributed in the hope that it will be useful,
//  but WITHOUT ANY WARRANTY; without even the implied warranty of
//  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
//  GNU General Public License for more details.
//
//  You should have received a copy of the GNU General Public License
//  along with this program; if not, write to the Free Software
//  Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 
#ifndef HEADER_ABSTRACT_CHARACTERISTICS_HPP
#define HEADER_ABSTRACT_CHARACTERISTICS_HPP
 
#include <string>
#include <vector>
 
class InterpolationArray;
 
class AbstractCharacteristic
{
public:
    union Value
    {
        float *f;
        bool *b;
        std::vector<float> *fv;
        InterpolationArray *ia;
 
        Value(float *f) : f(f) {}
        Value(bool *b) : b(b) {}
        Value(std::vector<float> *fv) : fv(fv) {}
        Value(InterpolationArray *ia) : ia(ia) {}
    };
 
    enum ValueType
    {
        TYPE_FLOAT,
        TYPE_BOOL,
        TYPE_FLOAT_VECTOR,
        TYPE_INTERPOLATION_ARRAY
    };
 
    enum CharacteristicType
    {
        // Script-generated content generated by tools/create_kart_properties.py enum
        // Please don't change the following tag. It will be automatically detected
        // by the script and replace the contained content.
        // To update the code, use tools/update_characteristics.py
        /* <characteristics-start enum> */
 
        // Suspension
        SUSPENSION_STIFFNESS,
        SUSPENSION_REST,
        SUSPENSION_TRAVEL,
        SUSPENSION_EXP_SPRING_RESPONSE,
        SUSPENSION_MAX_FORCE,
 
        // Stability
        STABILITY_ROLL_INFLUENCE,
        STABILITY_CHASSIS_LINEAR_DAMPING,
        STABILITY_CHASSIS_ANGULAR_DAMPING,
        STABILITY_DOWNWARD_IMPULSE_FACTOR,
        STABILITY_TRACK_CONNECTION_ACCEL,
        STABILITY_ANGULAR_FACTOR,
        STABILITY_SMOOTH_FLYING_IMPULSE,
 
        // Turn
        TURN_RADIUS,
        TURN_TIME_RESET_STEER,
        TURN_TIME_FULL_STEER,
 
        // Engine
        ENGINE_POWER,
        ENGINE_MAX_SPEED,
        ENGINE_GENERIC_MAX_SPEED,
        ENGINE_BRAKE_FACTOR,
        ENGINE_BRAKE_TIME_INCREASE,
        ENGINE_MAX_SPEED_REVERSE_RATIO,
 
        // Gear
        GEAR_SWITCH_RATIO,
        GEAR_POWER_INCREASE,
 
        // Mass
        MASS,
 
        // Wheels
        WHEELS_DAMPING_RELAXATION,
        WHEELS_DAMPING_COMPRESSION,
 
        // Jump
        JUMP_ANIMATION_TIME,
 
        // Lean
        LEAN_MAX,
        LEAN_SPEED,
 
        // Anvil
        ANVIL_DURATION,
        ANVIL_WEIGHT,
        ANVIL_SPEED_FACTOR,
 
        // Parachute
        PARACHUTE_FRICTION,
        PARACHUTE_DURATION,
        PARACHUTE_DURATION_OTHER,
        PARACHUTE_DURATION_RANK_MULT,
        PARACHUTE_DURATION_SPEED_MULT,
        PARACHUTE_LBOUND_FRACTION,
        PARACHUTE_UBOUND_FRACTION,
        PARACHUTE_MAX_SPEED,
 
        // Friction
        FRICTION_KART_FRICTION,
 
        // Bubblegum
        BUBBLEGUM_DURATION,
        BUBBLEGUM_SPEED_FRACTION,
        BUBBLEGUM_TORQUE,
        BUBBLEGUM_FADE_IN_TIME,
        BUBBLEGUM_SHIELD_DURATION,
 
        // Zipper
        ZIPPER_DURATION,
        ZIPPER_FORCE,
        ZIPPER_SPEED_GAIN,
        ZIPPER_MAX_SPEED_INCREASE,
        ZIPPER_FADE_OUT_TIME,
 
        // Swatter
        SWATTER_DURATION,
        SWATTER_DISTANCE,
        SWATTER_SQUASH_DURATION,
        SWATTER_SQUASH_SLOWDOWN,
 
        // Plunger
        PLUNGER_BAND_MAX_LENGTH,
        PLUNGER_BAND_FORCE,
        PLUNGER_BAND_DURATION,
        PLUNGER_BAND_SPEED_INCREASE,
        PLUNGER_BAND_FADE_OUT_TIME,
        PLUNGER_IN_FACE_TIME,
 
        // Startup
        STARTUP_TIME,
        STARTUP_BOOST,
 
        // Rescue
        RESCUE_DURATION,
        RESCUE_VERT_OFFSET,
        RESCUE_HEIGHT,
 
        // Explosion
        EXPLOSION_DURATION,
        EXPLOSION_RADIUS,
        EXPLOSION_INVULNERABILITY_TIME,
 
        // Nitro
        NITRO_DURATION,
        NITRO_ENGINE_FORCE,
        NITRO_ENGINE_MULT,
        NITRO_CONSUMPTION,
        NITRO_SMALL_CONTAINER,
        NITRO_BIG_CONTAINER,
        NITRO_MAX_SPEED_INCREASE,
        NITRO_FADE_OUT_TIME,
        NITRO_MAX,
 
        // Slipstream
        SLIPSTREAM_DURATION_FACTOR,
        SLIPSTREAM_BASE_SPEED,
        SLIPSTREAM_LENGTH,
        SLIPSTREAM_WIDTH,
        SLIPSTREAM_INNER_FACTOR,
        SLIPSTREAM_MIN_COLLECT_TIME,
        SLIPSTREAM_MAX_COLLECT_TIME,
        SLIPSTREAM_ADD_POWER,
        SLIPSTREAM_MIN_SPEED,
        SLIPSTREAM_MAX_SPEED_INCREASE,
        SLIPSTREAM_FADE_OUT_TIME,
 
        // Skid
        SKID_INCREASE,
        SKID_DECREASE,
        SKID_MAX,
        SKID_TIME_TILL_MAX,
        SKID_VISUAL,
        SKID_VISUAL_TIME,
        SKID_REVERT_VISUAL_TIME,
        SKID_MIN_SPEED,
        SKID_TIME_TILL_BONUS,
        SKID_BONUS_SPEED,
        SKID_BONUS_TIME,
        SKID_BONUS_FORCE,
        SKID_PHYSICAL_JUMP_TIME,
        SKID_GRAPHICAL_JUMP_TIME,
        SKID_POST_SKID_ROTATE_FACTOR,
        SKID_REDUCE_TURN_MIN,
        SKID_REDUCE_TURN_MAX,
        SKID_ENABLED,
 
        /* <characteristics-end enum> */
 
 
        // Count
        CHARACTERISTIC_COUNT
    };
 
public:
    AbstractCharacteristic();
    virtual ~AbstractCharacteristic() {}
    virtual void copyFrom(const AbstractCharacteristic *other) = 0;
 
    virtual void process(CharacteristicType type, Value value, bool *is_set) const;
 
    static ValueType getType(CharacteristicType type);
    static std::string getName(CharacteristicType type);
 
 
    // Script-generated content generated by tools/create_kart_properties.py defs
    // Please don't change the following tag. It will be automatically detected
    // by the script and replace the contained content.
    // To update the code, use tools/update_characteristics.py
    /* <characteristics-start acdefs> */
 
    float getSuspensionStiffness() const;
    float getSuspensionRest() const;
    float getSuspensionTravel() const;
    bool getSuspensionExpSpringResponse() const;
    float getSuspensionMaxForce() const;
 
    float getStabilityRollInfluence() const;
    float getStabilityChassisLinearDamping() const;
    float getStabilityChassisAngularDamping() const;
    float getStabilityDownwardImpulseFactor() const;
    float getStabilityTrackConnectionAccel() const;
    std::vector<float> getStabilityAngularFactor() const;
    float getStabilitySmoothFlyingImpulse() const;
 
    InterpolationArray getTurnRadius() const;
    float getTurnTimeResetSteer() const;
    InterpolationArray getTurnTimeFullSteer() const;
 
    float getEnginePower() const;
    float getEngineMaxSpeed() const;
    float getEngineGenericMaxSpeed() const;
    float getEngineBrakeFactor() const;
    float getEngineBrakeTimeIncrease() const;
    float getEngineMaxSpeedReverseRatio() const;
 
    std::vector<float> getGearSwitchRatio() const;
    std::vector<float> getGearPowerIncrease() const;
 
    float getMass() const;
 
    float getWheelsDampingRelaxation() const;
    float getWheelsDampingCompression() const;
 
    float getJumpAnimationTime() const;
 
    float getLeanMax() const;
    float getLeanSpeed() const;
 
    float getAnvilDuration() const;
    float getAnvilWeight() const;
    float getAnvilSpeedFactor() const;
 
    float getParachuteFriction() const;
    float getParachuteDuration() const;
    float getParachuteDurationOther() const;
    float getParachuteDurationRankMult() const;
    float getParachuteDurationSpeedMult() const;
    float getParachuteLboundFraction() const;
    float getParachuteUboundFraction() const;
    float getParachuteMaxSpeed() const;
 
    float getFrictionKartFriction() const;
 
    float getBubblegumDuration() const;
    float getBubblegumSpeedFraction() const;
    float getBubblegumTorque() const;
    float getBubblegumFadeInTime() const;
    float getBubblegumShieldDuration() const;
 
    float getZipperDuration() const;
    float getZipperForce() const;
    float getZipperSpeedGain() const;
    float getZipperMaxSpeedIncrease() const;
    float getZipperFadeOutTime() const;
 
    float getSwatterDuration() const;
    float getSwatterDistance() const;
    float getSwatterSquashDuration() const;
    float getSwatterSquashSlowdown() const;
 
    float getPlungerBandMaxLength() const;
    float getPlungerBandForce() const;
    float getPlungerBandDuration() const;
    float getPlungerBandSpeedIncrease() const;
    float getPlungerBandFadeOutTime() const;
    float getPlungerInFaceTime() const;
 
    std::vector<float> getStartupTime() const;
    std::vector<float> getStartupBoost() const;
 
    float getRescueDuration() const;
    float getRescueVertOffset() const;
    float getRescueHeight() const;
 
    float getExplosionDuration() const;
    float getExplosionRadius() const;
    float getExplosionInvulnerabilityTime() const;
 
    float getNitroDuration() const;
    float getNitroEngineForce() const;
    float getNitroEngineMult() const;
    float getNitroConsumption() const;
    float getNitroSmallContainer() const;
    float getNitroBigContainer() const;
    float getNitroMaxSpeedIncrease() const;
    float getNitroFadeOutTime() const;
    float getNitroMax() const;
 
    float getSlipstreamDurationFactor() const;
    float getSlipstreamBaseSpeed() const;
    float getSlipstreamLength() const;
    float getSlipstreamWidth() const;
    float getSlipstreamInnerFactor() const;
    float getSlipstreamMinCollectTime() const;
    float getSlipstreamMaxCollectTime() const;
    float getSlipstreamAddPower() const;
    float getSlipstreamMinSpeed() const;
    float getSlipstreamMaxSpeedIncrease() const;
    float getSlipstreamFadeOutTime() const;
 
    float getSkidIncrease() const;
    float getSkidDecrease() const;
    float getSkidMax() const;
    float getSkidTimeTillMax() const;
    float getSkidVisual() const;
    float getSkidVisualTime() const;
    float getSkidRevertVisualTime() const;
    float getSkidMinSpeed() const;
    std::vector<float> getSkidTimeTillBonus() const;
    std::vector<float> getSkidBonusSpeed() const;
    std::vector<float> getSkidBonusTime() const;
    std::vector<float> getSkidBonusForce() const;
    float getSkidPhysicalJumpTime() const;
    float getSkidGraphicalJumpTime() const;
    float getSkidPostSkidRotateFactor() const;
    float getSkidReduceTurnMin() const;
    float getSkidReduceTurnMax() const;
    bool getSkidEnabled() const;
 
    /* <characteristics-end acdefs> */
};
 
#endif