Function CmdFoundTown

src/town_cmd.cpp:2197–2287

* Create a new town. * @param flags The type of operation. * @param tile The coordinates where town is built. * @param size The size of the town (@see TownSize). * @param city Should we build a city? * @param layout The town road layout (@see TownLayout). * @param random_location Should we use a random location? (randomize \c tile ) * @param townnameparts Town name parts. * @param text Cus

 * @return The cost of this operation or an error.
 */
std::tuple<CommandCost, Money, TownID> CmdFoundTown(DoCommandFlags flags, TileIndex tile, TownSize size, bool city, TownLayout layout, bool random_location, uint32_t townnameparts, const std::string &text)
{
	TownNameParams par(_settings_game.game_creation.town_name);

	if (size >= TSZ_END) return { CMD_ERROR, 0, TownID::Invalid() };
	if (layout >= NUM_TLS) return { CMD_ERROR, 0, TownID::Invalid() };

	/* Some things are allowed only in the scenario editor and for game scripts. */
	if (_game_mode != GM_EDITOR && _current_company != OWNER_DEITY) {
		if (_settings_game.economy.found_town == TF_FORBIDDEN) return { CMD_ERROR, 0, TownID::Invalid() };
		if (size == TSZ_LARGE) return { CMD_ERROR, 0, TownID::Invalid() };
		if (random_location) return { CMD_ERROR, 0, TownID::Invalid() };
		if (_settings_game.economy.found_town != TF_CUSTOM_LAYOUT && layout != _settings_game.economy.town_layout) {
			return { CMD_ERROR, 0, TownID::Invalid() };
		}
	} else if (_current_company == OWNER_DEITY && random_location) {
		/* Random parameter is not allowed for Game Scripts. */
		return { CMD_ERROR, 0, TownID::Invalid() };
	}

	if (text.empty()) {
		/* If supplied name is empty, townnameparts has to generate unique automatic name */
		if (!VerifyTownName(townnameparts, &par)) return { CommandCost(STR_ERROR_NAME_MUST_BE_UNIQUE), 0, TownID::Invalid() };
	} else {
		/* If name is not empty, it has to be unique custom name */
		if (Utf8StringLength(text) >= MAX_LENGTH_TOWN_NAME_CHARS) return { CMD_ERROR, 0, TownID::Invalid() };
		if (!IsUniqueTownName(text)) return { CommandCost(STR_ERROR_NAME_MUST_BE_UNIQUE), 0, TownID::Invalid() };
	}

	/* Allocate town struct */
	if (!Town::CanAllocateItem()) return { CommandCost(STR_ERROR_TOO_MANY_TOWNS), 0, TownID::Invalid() };

	if (!random_location) {
		CommandCost ret = TownCanBePlacedHere(tile, false);
		if (ret.Failed()) return { ret, 0, TownID::Invalid() };
	}

	static const uint8_t price_mult[][TSZ_RANDOM + 1] = {{ 15, 25, 40, 25 }, { 20, 35, 55, 35 }};
	/* multidimensional arrays have to have defined length of non-first dimension */
	static_assert(lengthof(price_mult[0]) == 4);

	CommandCost cost(EXPENSES_OTHER, _price[PR_BUILD_TOWN]);
	uint8_t mult = price_mult[city][size];

	cost.MultiplyCost(mult);

	/* Create the town */
	TownID new_town = TownID::Invalid();
	if (flags.Test(DoCommandFlag::Execute)) {
		if (cost.GetCost() > GetAvailableMoneyForCommand()) {
			return { CommandCost(EXPENSES_OTHER), cost.GetCost(), TownID::Invalid() };
		}

		Backup<bool> old_generating_world(_generating_world, true);
		UpdateNearestTownForRoadTiles(true);
		Town *t;
		if (random_location) {
			t = CreateRandomTown(20, townnameparts, size, city, layout);