/*
 * Copyright (C) 2023  Christopher J. Howard
 *
 * This file is part of Antkeeper source code.
 *
 * Antkeeper source code 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.
 *
 * Antkeeper source code 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 Antkeeper source code.  If not, see <http://www.gnu.org/licenses/>.
 */

#ifndef ANTKEEPER_GAME_ANT_FOUNDING_MODE_GENE_HPP
#define ANTKEEPER_GAME_ANT_FOUNDING_MODE_GENE_HPP

#include "game/ant/genes/ant-gene.hpp"
#include <cstdint>

/**
 * Colony founding mode phene.
 *
 * @see https://www.antwiki.org/wiki/Colony_Foundation
 */
enum class ant_founding_mode_phene: std::uint8_t
{
	/// Foraging outside the claustral chamber is required.
	semi_claustral,
	
	/// Foraging outside the claustral chamber is unnecessary.
	claustral,
	
	/// Parent colony splits, with a queen taking a portion of the workforce with her.
	fission
};

/// Ant founding mode gene.
using ant_founding_mode_gene = ant_gene<ant_founding_mode_phene>;

template <>
inline constexpr ant_gene_type ant_founding_mode_gene::type() const noexcept
{
	return ant_gene_type::founding_mode;
}

#endif // ANTKEEPER_GAME_ANT_FOUNDING_MODE_GENE_HPP