wesnoth/unit_types.hpp

/*
   Copyright (C) 2003 by David White <davidnwhite@optusnet.com.au>
   Part of the Battle for Wesnoth Project http://wesnoth.whitevine.net

   This program is free software; you can redistribute it and/or modify
   it under the terms of the GNU General Public License.
   This program is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY.

   See the COPYING file for more details.
*/
#ifndef UNIT_TYPES_H_INCLUDED
#define UNIT_TYPES_H_INCLUDED

#include "config.hpp"
#include "map.hpp"
#include "team.hpp"

#include <string>
#include <vector>

//the 'attack type' is the type of attack, how many times it strikes,
//and how much damage it does.
class attack_type
{
public:
	enum RANGE { SHORT_RANGE, LONG_RANGE };
	
	attack_type(config& cfg);
	const std::string& name() const;
	const std::string& type() const;
	const std::string& special() const;
	RANGE range() const;
	int damage() const;
	int num_attacks() const;

	enum FRAME_TYPE { UNIT_FRAME, MISSILE_FRAME };
	enum FRAME_DIRECTION { VERTICAL, DIAGONAL };

	int get_first_frame(FRAME_TYPE type=UNIT_FRAME) const;
	int get_last_frame(FRAME_TYPE type=UNIT_FRAME) const;

	//function which gets an attack animation frame. The argument
	//is 0 for the frame at the time of impact, and negative for
	//frames before the time of impact
	const std::string* get_frame(int milliseconds, FRAME_TYPE type=UNIT_FRAME,
	                             FRAME_DIRECTION direction=VERTICAL) const;

	struct sfx {
		int time;
		std::string on_hit, on_miss;
	};

	const std::vector<sfx>& sound_effects() const;

	bool matches_filter(config& cfg) const;
	void apply_modification(config& cfg);
private:
	std::string name_;
	std::string type_;
	std::string special_;
	RANGE range_;
	int damage_;
	int num_attacks_;

	struct frame {
		frame(int i1, int i2, const std::string& img)
		      : start(i1), end(i2), image(&img), image_diagonal(NULL)
		{}

		frame(int i1, int i2, const std::string& img, const std::string& diag)
		      : start(i1), end(i2), image(&img), image_diagonal(&diag)
		{}

		int start, end;
		const std::string* image;
		const std::string* image_diagonal;
	};

	std::vector<frame> frames_[2];

	std::vector<sfx> sfx_;
};

//the 'unit movement type' is the basic size of the unit - flying, small land,
//large land, etc etc.
class unit_movement_type
{
public:
	//this class assumes that the passed in reference will remain valid
	//for at least as long as the class instance
	unit_movement_type(config& cfg);

	const std::string& name() const;
	int movement_cost(const gamemap& map, gamemap::TERRAIN terrain) const;
	double defense_modifier(const gamemap& map, gamemap::TERRAIN terrain) const;
	int damage_against(const attack_type& attack) const;

	const std::map<std::string,std::string>& damage_table() const;

private:
	mutable config& cfg_;

	mutable std::map<gamemap::TERRAIN,int> moveCosts_;
	mutable std::map<gamemap::TERRAIN,double> defenseMods_;
};

typedef std::map<std::string,unit_movement_type> movement_type_map;

class unit_type
{
public:
	//this class assumes that the passed in references will remain valid
	//for at least as long as the class instance
	unit_type(config& cfg, const movement_type_map& movement_types,
	          std::vector<config*>& traits);

	//the name of the unit in the current language setting
	std::string language_name() const;

	//unique identifier that doesn't have any whitespace
	std::string id() const;
	const std::string& name() const;
	const std::string& image() const;
	const std::string& image_profile() const;
	const std::string& image_defensive() const;
	const std::string& unit_description() const;
	int hitpoints() const;
	std::vector<attack_type> attacks() const;
	const unit_movement_type& movement_type() const;
	
	int experience_needed() const;
	std::vector<std::string> advances_to() const;
	const std::string& usage() const;

	int level() const;
	int movement() const;
	int cost() const;

	enum ALIGNMENT { LAWFUL, NEUTRAL, CHAOTIC };

	ALIGNMENT alignment() const;
	static const std::string& alignment_description(ALIGNMENT align);

	double alpha() const;

	const std::string& ability() const;

	//max_unit_healing returns the maximum hitpoints a unit next to this
	//unit can heal per turn. heals returns the total amount of hitpoints
	//this unit can heal out of all adjacent units
	int max_unit_healing() const;
	int heals() const;
	bool regenerates() const;
	bool is_leader() const;
	bool is_lightbringer() const;
	bool is_skirmisher() const;
	bool teleports() const;
	bool nightvision() const;

	bool has_ability(const std::string& ability) const;

	const std::vector<config*>& possible_traits() const;

private:
	mutable config& cfg_;

	double alpha_;

	int max_heals_;
	int heals_;
	bool regenerates_;
	bool leadership_;
	bool lightbringer_;
	bool skirmish_;
	bool teleport_;
	bool nightvision_;

	const unit_movement_type* movementType_;

	std::vector<config*>& possibleTraits_;
};

struct game_data
{
	game_data(config& cfg);
	movement_type_map movement_types;
	std::map<std::string,unit_type> unit_types;
};

#endif