432 lines
16 KiB
C++
432 lines
16 KiB
C++
//
|
|
// SuperTuxKart - a fun racing game with go-kart
|
|
// Copyright (C) 2006-2015 Joerg Henrichs
|
|
//
|
|
// 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.
|
|
|
|
#include "config/stk_config.hpp"
|
|
|
|
#include <stdexcept>
|
|
#include <stdio.h>
|
|
#include <sstream>
|
|
|
|
#include "audio/music_information.hpp"
|
|
#include "io/file_manager.hpp"
|
|
#include "io/xml_node.hpp"
|
|
#include "items/item.hpp"
|
|
#include "karts/kart_properties.hpp"
|
|
#include "karts/player_difficulty.hpp"
|
|
#include "utils/log.hpp"
|
|
|
|
STKConfig* stk_config=0;
|
|
float STKConfig::UNDEFINED = -99.9f;
|
|
|
|
//-----------------------------------------------------------------------------
|
|
/** Constructor, which only initialises the object. The actual work is done
|
|
* by calling load().
|
|
*/
|
|
STKConfig::STKConfig()
|
|
{
|
|
m_has_been_loaded = false;
|
|
m_title_music = NULL;
|
|
m_default_kart_properties = new KartProperties();
|
|
} // STKConfig
|
|
//-----------------------------------------------------------------------------
|
|
STKConfig::~STKConfig()
|
|
{
|
|
if(m_title_music)
|
|
delete m_title_music;
|
|
|
|
if(m_default_kart_properties)
|
|
delete m_default_kart_properties;
|
|
|
|
for(std::map<std::string, KartProperties*>::iterator it = m_kart_properties.begin();
|
|
it != m_kart_properties.end(); ++it)
|
|
{
|
|
if (it->second)
|
|
delete it->second;
|
|
}
|
|
} // ~STKConfig
|
|
|
|
//-----------------------------------------------------------------------------
|
|
/** Loads the stk configuration file. After loading it checks if all necessary
|
|
* values are actually defined, otherwise an error message is printed and STK
|
|
* is aborted.
|
|
* /param filename Name of the configuration file to load.
|
|
*/
|
|
void STKConfig::load(const std::string &filename)
|
|
{
|
|
// Avoid loading the default config file if a user-specific
|
|
// config file has already been loaded.
|
|
if(m_has_been_loaded) return;
|
|
m_has_been_loaded = true;
|
|
|
|
init_defaults();
|
|
|
|
XMLNode *root = 0;
|
|
try
|
|
{
|
|
root = new XMLNode(filename);
|
|
if(!root || root->getName()!="config")
|
|
{
|
|
if(root) delete root;
|
|
std::ostringstream msg;
|
|
msg << "Couldn't load config '" << filename << "': no config node.";
|
|
throw std::runtime_error(msg.str());
|
|
}
|
|
getAllData(root);
|
|
}
|
|
|
|
catch(std::exception& err)
|
|
{
|
|
Log::error("StkConfig", "FATAL ERROR while reading '%s':", filename.c_str());
|
|
Log::fatal("StkConfig", " %s", err.what());
|
|
}
|
|
delete root;
|
|
|
|
// Check that all necessary values are indeed set
|
|
// -----------------------------------------------
|
|
|
|
#define CHECK_NEG( a,strA) if(a<=UNDEFINED) { \
|
|
Log::fatal("StkConfig", "Missing default value for '%s' in '%s'.", \
|
|
strA,filename.c_str()); \
|
|
}
|
|
|
|
if(m_score_increase.size()==0 || (int)m_score_increase.size()!=m_max_karts)
|
|
{
|
|
Log::fatal("StkConfig", "Not or not enough scores defined in stk_config");
|
|
}
|
|
if(m_leader_intervals.size()==0)
|
|
{
|
|
Log::fatal("StkConfig", "No follow leader interval(s) defined in stk_config");
|
|
}
|
|
|
|
if(m_switch_items.size()!=Item::ITEM_LAST-Item::ITEM_FIRST+1)
|
|
{
|
|
Log::fatal("StkConfig", "Wrong number of item switches defined in stk_config");
|
|
}
|
|
|
|
CHECK_NEG(m_max_karts, "<karts max=..." );
|
|
CHECK_NEG(m_parachute_friction, "parachute-friction" );
|
|
CHECK_NEG(m_parachute_lbound_fraction, "parachute-lbound-fraction" );
|
|
CHECK_NEG(m_parachute_ubound_fraction, "parachute-ubound-fraction" );
|
|
CHECK_NEG(m_parachute_max_speed, "parachute-max-speed" );
|
|
CHECK_NEG(m_parachute_time, "parachute-time" );
|
|
CHECK_NEG(m_parachute_time_other, "parachute-time-other" );
|
|
CHECK_NEG(m_bomb_time, "bomb-time" );
|
|
CHECK_NEG(m_bomb_time_increase, "bomb-time-increase" );
|
|
CHECK_NEG(m_anvil_time, "anvil-time" );
|
|
CHECK_NEG(m_anvil_weight, "anvil-weight" );
|
|
CHECK_NEG(m_item_switch_time, "item-switch-time" );
|
|
CHECK_NEG(m_bubblegum_counter, "bubblegum disappear counter");
|
|
CHECK_NEG(m_bubblegum_shield_time, "bubblegum shield-time" );
|
|
CHECK_NEG(m_explosion_impulse_objects, "explosion-impulse-objects" );
|
|
CHECK_NEG(m_max_skidmarks, "max-skidmarks" );
|
|
CHECK_NEG(m_min_kart_version, "<kart-version min...>" );
|
|
CHECK_NEG(m_max_kart_version, "<kart-version max=...>" );
|
|
CHECK_NEG(m_min_track_version, "min-track-version" );
|
|
CHECK_NEG(m_max_track_version, "max-track-version" );
|
|
CHECK_NEG(m_skid_fadeout_time, "skid-fadeout-time" );
|
|
CHECK_NEG(m_near_ground, "near-ground" );
|
|
CHECK_NEG(m_delay_finish_time, "delay-finish-time" );
|
|
CHECK_NEG(m_music_credit_time, "music-credit-time" );
|
|
CHECK_NEG(m_leader_time_per_kart, "leader time-per-kart" );
|
|
CHECK_NEG(m_penalty_time, "penalty-time" );
|
|
CHECK_NEG(m_max_display_news, "max-display-news" );
|
|
CHECK_NEG(m_replay_max_time, "replay max-time" );
|
|
CHECK_NEG(m_replay_delta_angle, "replay delta-angle" );
|
|
CHECK_NEG(m_replay_delta_pos2, "replay delta-position" );
|
|
CHECK_NEG(m_replay_dt, "replay delta-t" );
|
|
CHECK_NEG(m_smooth_angle_limit, "physics smooth-angle-limit" );
|
|
|
|
// Square distance to make distance checks cheaper (no sqrt)
|
|
m_replay_delta_pos2 *= m_replay_delta_pos2;
|
|
m_default_kart_properties->checkAllSet(filename);
|
|
} // load
|
|
|
|
// -----------------------------------------------------------------------------
|
|
/** Init all values with invalid defaults, which are tested later. This
|
|
* guarantees that all parameters will indeed be initialised, and helps
|
|
* finding typos.
|
|
*/
|
|
void STKConfig::init_defaults()
|
|
{
|
|
m_anvil_weight = m_parachute_friction =
|
|
m_parachute_time = m_parachute_lbound_fraction =
|
|
m_parachute_time_other = m_anvil_speed_factor =
|
|
m_bomb_time = m_bomb_time_increase =
|
|
m_anvil_time = m_music_credit_time =
|
|
m_delay_finish_time = m_skid_fadeout_time =
|
|
m_near_ground = m_item_switch_time =
|
|
m_smooth_angle_limit = m_parachute_ubound_fraction =
|
|
m_penalty_time = m_explosion_impulse_objects =
|
|
m_parachute_max_speed = UNDEFINED;
|
|
m_bubblegum_counter = -100;
|
|
m_bubblegum_shield_time = -100;
|
|
m_shield_restrict_weapos = false;
|
|
m_max_karts = -100;
|
|
m_max_skidmarks = -100;
|
|
m_min_kart_version = -100;
|
|
m_max_kart_version = -100;
|
|
m_min_track_version = -100;
|
|
m_max_track_version = -100;
|
|
m_max_display_news = -100;
|
|
m_replay_max_time = -100;
|
|
m_replay_delta_angle = -100;
|
|
m_replay_delta_pos2 = -100;
|
|
m_replay_dt = -100;
|
|
m_title_music = NULL;
|
|
m_enable_networking = true;
|
|
m_smooth_normals = false;
|
|
m_same_powerup_mode = POWERUP_MODE_ONLY_IF_SAME;
|
|
m_ai_acceleration = 1.0f;
|
|
m_disable_steer_while_unskid = false;
|
|
m_camera_follow_skid = false;
|
|
|
|
m_score_increase.clear();
|
|
m_leader_intervals.clear();
|
|
m_switch_items.clear();
|
|
} // init_defaults
|
|
|
|
//-----------------------------------------------------------------------------
|
|
/** Extracts the actual information from a xml file.
|
|
* \param xml Pointer to the xml data structure.
|
|
*/
|
|
void STKConfig::getAllData(const XMLNode * root)
|
|
{
|
|
// Get the values which are not part of the default KartProperties
|
|
// ---------------------------------------------------------------
|
|
if(const XMLNode *kart_node = root->getNode("kart-version"))
|
|
{
|
|
kart_node->get("min", &m_min_kart_version);
|
|
kart_node->get("max", &m_max_kart_version);
|
|
}
|
|
|
|
if(const XMLNode *node = root->getNode("track-version"))
|
|
{
|
|
node->get("min", &m_min_track_version);
|
|
node->get("max", &m_max_track_version);
|
|
}
|
|
|
|
if(const XMLNode *kart_node = root->getNode("karts"))
|
|
kart_node->get("max-number", &m_max_karts);
|
|
|
|
if(const XMLNode *gp_node = root->getNode("grand-prix"))
|
|
{
|
|
for(unsigned int i=0; i<gp_node->getNumNodes(); i++)
|
|
{
|
|
const XMLNode *pn=gp_node->getNode(i);
|
|
int from=-1;
|
|
pn->get("from", &from);
|
|
int to=-1;
|
|
pn->get("to", &to);
|
|
if(to<0) to=m_max_karts;
|
|
int points=-1;
|
|
pn->get("points", &points);
|
|
if(points<0 || from<0 || from>to||
|
|
(int)m_score_increase.size()!=from-1)
|
|
{
|
|
Log::error("StkConfig", "Incorrect GP point specification:");
|
|
Log::fatal("StkConfig", "from: %d to: %d points: %d",
|
|
from, to, points);
|
|
}
|
|
for(int j=from; j<=to; j++)
|
|
m_score_increase.push_back(points);
|
|
}
|
|
}
|
|
|
|
if(const XMLNode *leader_node= root->getNode("follow-the-leader"))
|
|
{
|
|
leader_node->get("intervals", &m_leader_intervals );
|
|
leader_node->get("time-per-kart", &m_leader_time_per_kart);
|
|
}
|
|
|
|
if (const XMLNode *physics_node= root->getNode("physics"))
|
|
{
|
|
physics_node->get("smooth-normals", &m_smooth_normals );
|
|
physics_node->get("smooth-angle-limit", &m_smooth_angle_limit);
|
|
}
|
|
|
|
if (const XMLNode *startup_node= root->getNode("startup"))
|
|
{
|
|
startup_node->get("penalty", &m_penalty_time );
|
|
}
|
|
|
|
if (const XMLNode *news_node= root->getNode("news"))
|
|
{
|
|
news_node->get("max-display", &m_max_display_news);
|
|
}
|
|
|
|
if (const XMLNode *steer_node= root->getNode("steer"))
|
|
{
|
|
steer_node->get("disable-while-unskid", &m_disable_steer_while_unskid);
|
|
steer_node->get("camera-follow-skid", &m_camera_follow_skid );
|
|
}
|
|
|
|
if (const XMLNode *music_node = root->getNode("music"))
|
|
{
|
|
std::string title_music;
|
|
music_node->get("title", &title_music);
|
|
assert(title_music.size() > 0);
|
|
title_music = file_manager->getAsset(FileManager::MUSIC, title_music);
|
|
m_title_music = MusicInformation::create(title_music);
|
|
if(!m_title_music)
|
|
Log::error("StkConfig", "Cannot load title music : %s", title_music.c_str());
|
|
}
|
|
|
|
if(const XMLNode *skidmarks_node = root->getNode("skid-marks"))
|
|
{
|
|
skidmarks_node->get("max-number", &m_max_skidmarks );
|
|
skidmarks_node->get("fadeout-time", &m_skid_fadeout_time);
|
|
}
|
|
|
|
if(const XMLNode *near_ground_node = root->getNode("near-ground"))
|
|
near_ground_node->get("distance", &m_near_ground);
|
|
|
|
if(const XMLNode *delay_finish_node= root->getNode("delay-finish"))
|
|
delay_finish_node->get("time", &m_delay_finish_time);
|
|
|
|
if(const XMLNode *credits_node= root->getNode("credits"))
|
|
credits_node->get("music", &m_music_credit_time);
|
|
|
|
|
|
if(const XMLNode *anvil_node= root->getNode("anvil"))
|
|
{
|
|
anvil_node->get("weight", &m_anvil_weight );
|
|
anvil_node->get("speed-factor", &m_anvil_speed_factor);
|
|
anvil_node->get("time", &m_anvil_time );
|
|
}
|
|
|
|
if(const XMLNode *parachute_node= root->getNode("parachute"))
|
|
{
|
|
parachute_node->get("friction", &m_parachute_friction );
|
|
parachute_node->get("time", &m_parachute_time );
|
|
parachute_node->get("time-other", &m_parachute_time_other );
|
|
parachute_node->get("lbound-fraction", &m_parachute_lbound_fraction);
|
|
parachute_node->get("ubound-fraction", &m_parachute_ubound_fraction);
|
|
parachute_node->get("max-speed", &m_parachute_max_speed );
|
|
}
|
|
|
|
if(const XMLNode *bomb_node= root->getNode("bomb"))
|
|
{
|
|
bomb_node->get("time", &m_bomb_time);
|
|
bomb_node->get("time-increase", &m_bomb_time_increase);
|
|
}
|
|
|
|
if(const XMLNode *powerup_node= root->getNode("powerup"))
|
|
{
|
|
std::string s;
|
|
powerup_node->get("collect-mode", &s);
|
|
if(s=="same")
|
|
m_same_powerup_mode = POWERUP_MODE_SAME;
|
|
else if(s=="new")
|
|
m_same_powerup_mode = POWERUP_MODE_NEW;
|
|
else if(s=="only-if-same")
|
|
m_same_powerup_mode = POWERUP_MODE_ONLY_IF_SAME;
|
|
else
|
|
{
|
|
Log::warn("StkConfig", "Invalid item mode '%s' - ignored.",
|
|
s.c_str());
|
|
}
|
|
}
|
|
|
|
if(const XMLNode *switch_node= root->getNode("switch"))
|
|
{
|
|
switch_node->get("items", &m_switch_items );
|
|
switch_node->get("time", &m_item_switch_time);
|
|
}
|
|
|
|
if(const XMLNode *bubblegum_node= root->getNode("bubblegum"))
|
|
{
|
|
bubblegum_node->get("disappear-counter", &m_bubblegum_counter );
|
|
bubblegum_node->get("shield-time", &m_bubblegum_shield_time );
|
|
bubblegum_node->get("restrict-weapons", &m_shield_restrict_weapos);
|
|
}
|
|
|
|
if(const XMLNode *explosion_node= root->getNode("explosion"))
|
|
{
|
|
explosion_node->get("impulse-objects", &m_explosion_impulse_objects);
|
|
}
|
|
|
|
if(const XMLNode *ai_node = root->getNode("ai"))
|
|
{
|
|
ai_node->get("acceleration", &m_ai_acceleration);
|
|
}
|
|
|
|
if(const XMLNode *networking_node= root->getNode("networking"))
|
|
networking_node->get("enable", &m_enable_networking);
|
|
|
|
if(const XMLNode *replay_node = root->getNode("replay"))
|
|
{
|
|
replay_node->get("delta-angle", &m_replay_delta_angle);
|
|
replay_node->get("delta-pos", &m_replay_delta_pos2 );
|
|
replay_node->get("delta-t", &m_replay_dt );
|
|
replay_node->get("max-time", &m_replay_max_time );
|
|
|
|
}
|
|
|
|
// Get the default KartProperties
|
|
// ------------------------------
|
|
const XMLNode *node = root -> getNode("general-kart-defaults");
|
|
if(!node)
|
|
{
|
|
std::ostringstream msg;
|
|
msg << "Couldn't load general-kart-defaults: no node.";
|
|
throw std::runtime_error(msg.str());
|
|
}
|
|
m_default_kart_properties->getAllData(node);
|
|
const XMLNode *child_node = node->getNode("kart-type");
|
|
|
|
for (unsigned int i = 0; i < child_node->getNumNodes(); ++i)
|
|
{
|
|
const XMLNode* type = child_node->getNode(i);
|
|
m_kart_properties[type->getName()] = new KartProperties();
|
|
m_kart_properties[type->getName()]->copyFrom(m_default_kart_properties);
|
|
m_kart_properties[type->getName()]->getAllData(type);
|
|
}
|
|
|
|
child_node = node->getNode("difficulties");
|
|
for (unsigned int i = 0; i < child_node->getNumNodes(); ++i)
|
|
{
|
|
const XMLNode* type = child_node->getNode(i);
|
|
m_player_difficulties[i] = new PlayerDifficulty();
|
|
m_player_difficulties[i]->getAllData(type);
|
|
m_player_difficulties[i]->setDifficulty((PerPlayerDifficulty) i);
|
|
}
|
|
} // getAllData
|
|
|
|
// ----------------------------------------------------------------------------
|
|
/** Defines the points for each position for a race with a given number
|
|
* of karts.
|
|
* \param all_scores A vector which will be resized to take num_karts
|
|
* elements and which on return contains the number of points
|
|
* for each position.
|
|
* \param num_karts Number of karts.
|
|
*/
|
|
void STKConfig::getAllScores(std::vector<int> *all_scores, int num_karts)
|
|
{
|
|
if (num_karts == 0) return;
|
|
|
|
assert(num_karts <= m_max_karts);
|
|
all_scores->resize(num_karts);
|
|
(*all_scores)[num_karts-1] = 1; // last position gets one point
|
|
|
|
// Must be signed, in case that num_karts==1
|
|
for(int i=num_karts-2; i>=0; i--)
|
|
{
|
|
(*all_scores)[i] = (*all_scores)[i+1] + m_score_increase[i];
|
|
}
|
|
} // getAllScores
|