race.hpp

Go to the documentation of this file.

/*
    Copyright (C) 2003 - 2024
    by David White <dave@whitevine.net>
    Part of the Battle for Wesnoth Project https://www.wesnoth.org/
 
    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 2 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.
 
    See the COPYING file for more details.
*/
 
#pragma once
 
#include "config.hpp"
#include "global.hpp"
#include "utils/name_generator.hpp"
 
#include <array>
#include <memory>
 
class unit_race
{
public:
    enum GENDER { MALE, FEMALE, NUM_GENDERS };
    static const std::string s_female;
    static const std::string s_male;
 
 
    explicit unit_race(const config& cfg);
 
    const config& get_cfg() const { return cfg_; }
    const std::string& id() const { return id_; }
    const std::string& editor_icon() const { return icon_; }
    const t_string& name(GENDER gender=MALE) const { return name_[gender]; }
    const t_string& plural_name() const { return plural_name_; }
    const t_string& description() const { return description_; }
 
    std::string generate_name(GENDER gender) const;
    const name_generator& generator(GENDER gender) const;
 
    bool uses_global_traits() const;
 
    const config::const_child_itors &additional_traits() const;
    const config::const_child_itors &additional_topics() const;
    unsigned int num_traits() const;
    const std::string& undead_variation() const { return undead_variation_; }
 
    /**
     * Gets this race's icon path without state/size suffix and extension.
     *
     * This doesn't return the full path. Its output looks something like this:
     * @c icons/unit-groups/race_elf
     *
     * This is because this output is used in the editor for a GUI1 button's icon,
     * and GUI1 automatically appends the state extension, such as "_30-pressed.png"
     *
     * If a custom icon has been provided, that is used. Else, it checks if an
     * appropriate icon exists in icons/unit-groups/. If not, a generic custom race
     * icon will be used.
     */
    std::string get_icon_path_stem() const;
 
    const std::string& help_taxonomy() const { return help_taxonomy_; }
 
    /** Dummy race used when a race is not yet known. */
    static const unit_race null_race;
 
private:
    /** Only used to construct null_race. */
    unit_race();
 
    const config cfg_;
 
    std::string id_;
    std::string icon_;
    std::array<t_string, NUM_GENDERS> name_;
    t_string plural_name_;
    t_string description_;
    unsigned int ntraits_;
    std::array<std::shared_ptr<name_generator>, NUM_GENDERS> name_generator_;
 
    config::const_child_itors traits_;
    config::const_child_itors topics_;
    bool global_traits_;
    std::string undead_variation_;
    std::string help_taxonomy_;
};
 
unit_race::GENDER string_gender(const std::string& str,unit_race::GENDER def=unit_race::MALE);
const std::string& gender_string(unit_race::GENDER gender);
 
/**
 * Chooses a value from the given config based on gender. If the value for
 * the specified gender is blank, then @a default_key is used to look up a
 * value instead.
 */
NOT_DANGLING const config::attribute_value & gender_value(
    const config & cfg, unit_race::GENDER gender, const std::string & male_key,
    const std::string & female_key, const std::string & default_key);
 
typedef std::map<std::string,unit_race> race_map;