mirror of
https://github.com/OpenTTD/OpenTTD.git
synced 2025-06-19 11:39:35 +01:00
534f2419ad
These are functions that either use ScriptObject::Command or ScriptObject::GetCompany. This is a bit over-protective, but having the check everywhere makes it easier to validate that no check is missing automatically instead of by review. At this moment these checks will not do anything useful, as either IsValid or IsDeity from ScriptCompanyMode returns true, but that will change later.
384 lines
12 KiB
C++
384 lines
12 KiB
C++
/*
|
|
* This file is part of OpenTTD.
|
|
* OpenTTD 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, version 2.
|
|
* OpenTTD 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 OpenTTD. If not, see <http://www.gnu.org/licenses/>.
|
|
*/
|
|
|
|
/** @file script_town.cpp Implementation of ScriptTown. */
|
|
|
|
#include "../../stdafx.h"
|
|
#include "script_town.hpp"
|
|
#include "script_map.hpp"
|
|
#include "script_error.hpp"
|
|
#include "../../town.h"
|
|
#include "../../townname_func.h"
|
|
#include "../../string_func.h"
|
|
#include "../../strings_func.h"
|
|
#include "../../station_base.h"
|
|
#include "../../landscape.h"
|
|
#include "../../town_cmd.h"
|
|
#include "table/strings.h"
|
|
|
|
#include "../../safeguards.h"
|
|
|
|
/* static */ SQInteger ScriptTown::GetTownCount()
|
|
{
|
|
return ::Town::GetNumItems();
|
|
}
|
|
|
|
/* static */ bool ScriptTown::IsValidTown(TownID town_id)
|
|
{
|
|
return ::Town::IsValidID(town_id);
|
|
}
|
|
|
|
/* static */ char *ScriptTown::GetName(TownID town_id)
|
|
{
|
|
if (!IsValidTown(town_id)) return nullptr;
|
|
|
|
::SetDParam(0, town_id);
|
|
return GetString(STR_TOWN_NAME);
|
|
}
|
|
|
|
/* static */ bool ScriptTown::SetName(TownID town_id, Text *name)
|
|
{
|
|
CCountedPtr<Text> counter(name);
|
|
|
|
EnforcePrecondition(false, IsValidTown(town_id));
|
|
std::string text;
|
|
if (name != nullptr) {
|
|
text = name->GetDecodedText();
|
|
EnforcePreconditionCustomError(false, ::Utf8StringLength(text) < MAX_LENGTH_TOWN_NAME_CHARS, ScriptError::ERR_PRECONDITION_STRING_TOO_LONG);
|
|
}
|
|
|
|
return ScriptObject::Command<CMD_RENAME_TOWN>::Do(town_id, text);
|
|
}
|
|
|
|
/* static */ bool ScriptTown::SetText(TownID town_id, Text *text)
|
|
{
|
|
CCountedPtr<Text> counter(text);
|
|
|
|
EnforcePrecondition(false, IsValidTown(town_id));
|
|
|
|
return ScriptObject::Command<CMD_TOWN_SET_TEXT>::Do(town_id, text != nullptr ? text->GetEncodedText() : std::string{});
|
|
}
|
|
|
|
/* static */ SQInteger ScriptTown::GetPopulation(TownID town_id)
|
|
{
|
|
if (!IsValidTown(town_id)) return -1;
|
|
const Town *t = ::Town::Get(town_id);
|
|
return t->cache.population;
|
|
}
|
|
|
|
/* static */ SQInteger ScriptTown::GetHouseCount(TownID town_id)
|
|
{
|
|
if (!IsValidTown(town_id)) return -1;
|
|
const Town *t = ::Town::Get(town_id);
|
|
return t->cache.num_houses;
|
|
}
|
|
|
|
/* static */ TileIndex ScriptTown::GetLocation(TownID town_id)
|
|
{
|
|
if (!IsValidTown(town_id)) return INVALID_TILE;
|
|
const Town *t = ::Town::Get(town_id);
|
|
return t->xy;
|
|
}
|
|
|
|
/* static */ SQInteger ScriptTown::GetLastMonthProduction(TownID town_id, CargoID cargo_id)
|
|
{
|
|
if (!IsValidTown(town_id)) return -1;
|
|
if (!ScriptCargo::IsValidCargo(cargo_id)) return -1;
|
|
|
|
const Town *t = ::Town::Get(town_id);
|
|
|
|
return t->supplied[cargo_id].old_max;
|
|
}
|
|
|
|
/* static */ SQInteger ScriptTown::GetLastMonthSupplied(TownID town_id, CargoID cargo_id)
|
|
{
|
|
if (!IsValidTown(town_id)) return -1;
|
|
if (!ScriptCargo::IsValidCargo(cargo_id)) return -1;
|
|
|
|
const Town *t = ::Town::Get(town_id);
|
|
|
|
return t->supplied[cargo_id].old_act;
|
|
}
|
|
|
|
/* static */ SQInteger ScriptTown::GetLastMonthTransportedPercentage(TownID town_id, CargoID cargo_id)
|
|
{
|
|
if (!IsValidTown(town_id)) return -1;
|
|
if (!ScriptCargo::IsValidCargo(cargo_id)) return -1;
|
|
|
|
const Town *t = ::Town::Get(town_id);
|
|
return ::ToPercent8(t->GetPercentTransported(cargo_id));
|
|
}
|
|
|
|
/* static */ SQInteger ScriptTown::GetLastMonthReceived(TownID town_id, ScriptCargo::TownEffect towneffect_id)
|
|
{
|
|
if (!IsValidTown(town_id)) return -1;
|
|
if (!ScriptCargo::IsValidTownEffect(towneffect_id)) return -1;
|
|
|
|
const Town *t = ::Town::Get(town_id);
|
|
|
|
return t->received[towneffect_id].old_act;
|
|
}
|
|
|
|
/* static */ bool ScriptTown::SetCargoGoal(TownID town_id, ScriptCargo::TownEffect towneffect_id, SQInteger goal)
|
|
{
|
|
EnforcePrecondition(false, IsValidTown(town_id));
|
|
EnforcePrecondition(false, ScriptCargo::IsValidTownEffect(towneffect_id));
|
|
|
|
goal = Clamp<SQInteger>(goal, 0, UINT32_MAX);
|
|
|
|
return ScriptObject::Command<CMD_TOWN_CARGO_GOAL>::Do(town_id, (::TownEffect)towneffect_id, goal);
|
|
}
|
|
|
|
/* static */ SQInteger ScriptTown::GetCargoGoal(TownID town_id, ScriptCargo::TownEffect towneffect_id)
|
|
{
|
|
if (!IsValidTown(town_id)) return -1;
|
|
if (!ScriptCargo::IsValidTownEffect(towneffect_id)) return -1;
|
|
|
|
const Town *t = ::Town::Get(town_id);
|
|
|
|
switch (t->goal[towneffect_id]) {
|
|
case TOWN_GROWTH_WINTER:
|
|
if (TileHeight(t->xy) >= GetSnowLine() && t->cache.population > 90) return 1;
|
|
return 0;
|
|
|
|
case TOWN_GROWTH_DESERT:
|
|
if (GetTropicZone(t->xy) == TROPICZONE_DESERT && t->cache.population > 60) return 1;
|
|
return 0;
|
|
|
|
default: return t->goal[towneffect_id];
|
|
}
|
|
}
|
|
|
|
/* static */ bool ScriptTown::SetGrowthRate(TownID town_id, SQInteger days_between_town_growth)
|
|
{
|
|
EnforcePrecondition(false, IsValidTown(town_id));
|
|
uint16 growth_rate;
|
|
switch (days_between_town_growth) {
|
|
case TOWN_GROWTH_NORMAL:
|
|
growth_rate = 0;
|
|
break;
|
|
|
|
case TOWN_GROWTH_NONE:
|
|
growth_rate = TOWN_GROWTH_RATE_NONE;
|
|
break;
|
|
|
|
default:
|
|
EnforcePrecondition(false, (days_between_town_growth * DAY_TICKS / TOWN_GROWTH_TICKS) <= MAX_TOWN_GROWTH_TICKS);
|
|
/* Don't use growth_rate 0 as it means GROWTH_NORMAL */
|
|
growth_rate = std::max<SQInteger>(days_between_town_growth * DAY_TICKS, 2u) - 1;
|
|
break;
|
|
}
|
|
|
|
return ScriptObject::Command<CMD_TOWN_GROWTH_RATE>::Do(town_id, growth_rate);
|
|
}
|
|
|
|
/* static */ SQInteger ScriptTown::GetGrowthRate(TownID town_id)
|
|
{
|
|
if (!IsValidTown(town_id)) return -1;
|
|
|
|
const Town *t = ::Town::Get(town_id);
|
|
|
|
if (t->growth_rate == TOWN_GROWTH_RATE_NONE) return TOWN_GROWTH_NONE;
|
|
|
|
return RoundDivSU(t->growth_rate + 1, DAY_TICKS);
|
|
}
|
|
|
|
/* static */ SQInteger ScriptTown::GetDistanceManhattanToTile(TownID town_id, TileIndex tile)
|
|
{
|
|
return ScriptMap::DistanceManhattan(tile, GetLocation(town_id));
|
|
}
|
|
|
|
/* static */ SQInteger ScriptTown::GetDistanceSquareToTile(TownID town_id, TileIndex tile)
|
|
{
|
|
return ScriptMap::DistanceSquare(tile, GetLocation(town_id));
|
|
}
|
|
|
|
/* static */ bool ScriptTown::IsWithinTownInfluence(TownID town_id, TileIndex tile)
|
|
{
|
|
if (!IsValidTown(town_id)) return false;
|
|
|
|
const Town *t = ::Town::Get(town_id);
|
|
return ((uint32)GetDistanceSquareToTile(town_id, tile) <= t->cache.squared_town_zone_radius[0]);
|
|
}
|
|
|
|
/* static */ bool ScriptTown::HasStatue(TownID town_id)
|
|
{
|
|
EnforceCompanyModeValid(false);
|
|
if (!IsValidTown(town_id)) return false;
|
|
|
|
return ::HasBit(::Town::Get(town_id)->statues, ScriptObject::GetCompany());
|
|
}
|
|
|
|
/* static */ bool ScriptTown::IsCity(TownID town_id)
|
|
{
|
|
if (!IsValidTown(town_id)) return false;
|
|
|
|
return ::Town::Get(town_id)->larger_town;
|
|
}
|
|
|
|
/* static */ SQInteger ScriptTown::GetRoadReworkDuration(TownID town_id)
|
|
{
|
|
if (!IsValidTown(town_id)) return -1;
|
|
|
|
return ::Town::Get(town_id)->road_build_months;
|
|
}
|
|
|
|
/* static */ SQInteger ScriptTown::GetFundBuildingsDuration(TownID town_id)
|
|
{
|
|
if (!IsValidTown(town_id)) return -1;
|
|
|
|
return ::Town::Get(town_id)->fund_buildings_months;
|
|
}
|
|
|
|
/* static */ ScriptCompany::CompanyID ScriptTown::GetExclusiveRightsCompany(TownID town_id)
|
|
{
|
|
EnforceCompanyModeValid(ScriptCompany::COMPANY_INVALID);
|
|
if (!IsValidTown(town_id)) return ScriptCompany::COMPANY_INVALID;
|
|
|
|
return (ScriptCompany::CompanyID)(int8)::Town::Get(town_id)->exclusivity;
|
|
}
|
|
|
|
/* static */ SQInteger ScriptTown::GetExclusiveRightsDuration(TownID town_id)
|
|
{
|
|
if (!IsValidTown(town_id)) return -1;
|
|
|
|
return ::Town::Get(town_id)->exclusive_counter;
|
|
}
|
|
|
|
/* static */ bool ScriptTown::IsActionAvailable(TownID town_id, TownAction town_action)
|
|
{
|
|
EnforceCompanyModeValid(false);
|
|
if (!IsValidTown(town_id)) return false;
|
|
|
|
return HasBit(::GetMaskOfTownActions(ScriptObject::GetCompany(), ::Town::Get(town_id)), town_action);
|
|
}
|
|
|
|
/* static */ bool ScriptTown::PerformTownAction(TownID town_id, TownAction town_action)
|
|
{
|
|
EnforceCompanyModeValid(false);
|
|
EnforcePrecondition(false, IsValidTown(town_id));
|
|
EnforcePrecondition(false, IsActionAvailable(town_id, town_action));
|
|
|
|
return ScriptObject::Command<CMD_DO_TOWN_ACTION>::Do(town_id, town_action);
|
|
}
|
|
|
|
/* static */ bool ScriptTown::ExpandTown(TownID town_id, SQInteger houses)
|
|
{
|
|
EnforceDeityMode(false);
|
|
EnforcePrecondition(false, IsValidTown(town_id));
|
|
EnforcePrecondition(false, houses > 0);
|
|
|
|
houses = std::min<SQInteger>(houses, UINT32_MAX);
|
|
|
|
return ScriptObject::Command<CMD_EXPAND_TOWN>::Do(town_id, houses);
|
|
}
|
|
|
|
/* static */ bool ScriptTown::FoundTown(TileIndex tile, TownSize size, bool city, RoadLayout layout, Text *name)
|
|
{
|
|
CCountedPtr<Text> counter(name);
|
|
|
|
EnforceDeityOrCompanyModeValid(false);
|
|
EnforcePrecondition(false, ScriptCompanyMode::IsDeity() || _settings_game.economy.found_town != TF_FORBIDDEN);
|
|
EnforcePrecondition(false, ::IsValidTile(tile));
|
|
EnforcePrecondition(false, size == TOWN_SIZE_SMALL || size == TOWN_SIZE_MEDIUM || size == TOWN_SIZE_LARGE)
|
|
EnforcePrecondition(false, ScriptCompanyMode::IsDeity() || size != TOWN_SIZE_LARGE);
|
|
if (ScriptCompanyMode::IsDeity() || _settings_game.economy.found_town == TF_CUSTOM_LAYOUT) {
|
|
EnforcePrecondition(false, layout >= ROAD_LAYOUT_ORIGINAL && layout <= ROAD_LAYOUT_RANDOM);
|
|
} else {
|
|
/* The layout parameter is ignored for AIs when custom layouts is disabled. */
|
|
layout = (RoadLayout) (byte)_settings_game.economy.town_layout;
|
|
}
|
|
|
|
std::string text;
|
|
if (name != nullptr) {
|
|
text = name->GetDecodedText();
|
|
EnforcePreconditionCustomError(false, ::Utf8StringLength(text) < MAX_LENGTH_TOWN_NAME_CHARS, ScriptError::ERR_PRECONDITION_STRING_TOO_LONG);
|
|
}
|
|
uint32 townnameparts;
|
|
if (!GenerateTownName(ScriptObject::GetRandomizer(), &townnameparts)) {
|
|
ScriptObject::SetLastError(ScriptError::ERR_NAME_IS_NOT_UNIQUE);
|
|
return false;
|
|
}
|
|
|
|
return ScriptObject::Command<CMD_FOUND_TOWN>::Do(tile, (::TownSize)size, city, (::TownLayout)layout, false, townnameparts, text);
|
|
}
|
|
|
|
/* static */ ScriptTown::TownRating ScriptTown::GetRating(TownID town_id, ScriptCompany::CompanyID company_id)
|
|
{
|
|
if (!IsValidTown(town_id)) return TOWN_RATING_INVALID;
|
|
ScriptCompany::CompanyID company = ScriptCompany::ResolveCompanyID(company_id);
|
|
if (company == ScriptCompany::COMPANY_INVALID) return TOWN_RATING_INVALID;
|
|
|
|
const Town *t = ::Town::Get(town_id);
|
|
if (!HasBit(t->have_ratings, company)) {
|
|
return TOWN_RATING_NONE;
|
|
} else if (t->ratings[company] <= RATING_APPALLING) {
|
|
return TOWN_RATING_APPALLING;
|
|
} else if (t->ratings[company] <= RATING_VERYPOOR) {
|
|
return TOWN_RATING_VERY_POOR;
|
|
} else if (t->ratings[company] <= RATING_POOR) {
|
|
return TOWN_RATING_POOR;
|
|
} else if (t->ratings[company] <= RATING_MEDIOCRE) {
|
|
return TOWN_RATING_MEDIOCRE;
|
|
} else if (t->ratings[company] <= RATING_GOOD) {
|
|
return TOWN_RATING_GOOD;
|
|
} else if (t->ratings[company] <= RATING_VERYGOOD) {
|
|
return TOWN_RATING_VERY_GOOD;
|
|
} else if (t->ratings[company] <= RATING_EXCELLENT) {
|
|
return TOWN_RATING_EXCELLENT;
|
|
} else {
|
|
return TOWN_RATING_OUTSTANDING;
|
|
}
|
|
}
|
|
|
|
/* static */ SQInteger ScriptTown::GetDetailedRating(TownID town_id, ScriptCompany::CompanyID company_id)
|
|
{
|
|
if (!IsValidTown(town_id)) return TOWN_RATING_INVALID;
|
|
ScriptCompany::CompanyID company = ScriptCompany::ResolveCompanyID(company_id);
|
|
if (company == ScriptCompany::COMPANY_INVALID) return TOWN_RATING_INVALID;
|
|
|
|
const Town *t = ::Town::Get(town_id);
|
|
return t->ratings[company];
|
|
}
|
|
|
|
/* static */ bool ScriptTown::ChangeRating(TownID town_id, ScriptCompany::CompanyID company_id, SQInteger delta)
|
|
{
|
|
EnforceDeityMode(false);
|
|
EnforcePrecondition(false, IsValidTown(town_id));
|
|
ScriptCompany::CompanyID company = ScriptCompany::ResolveCompanyID(company_id);
|
|
EnforcePrecondition(false, company != ScriptCompany::COMPANY_INVALID);
|
|
|
|
const Town *t = ::Town::Get(town_id);
|
|
int16 new_rating = Clamp(t->ratings[company] + delta, RATING_MINIMUM, RATING_MAXIMUM);
|
|
if (new_rating == t->ratings[company]) return false;
|
|
|
|
return ScriptObject::Command<CMD_TOWN_RATING>::Do(town_id, (::CompanyID)company_id, new_rating);
|
|
}
|
|
|
|
/* static */ SQInteger ScriptTown::GetAllowedNoise(TownID town_id)
|
|
{
|
|
if (!IsValidTown(town_id)) return -1;
|
|
|
|
const Town *t = ::Town::Get(town_id);
|
|
if (_settings_game.economy.station_noise_level) {
|
|
return t->MaxTownNoise() - t->noise_reached;
|
|
}
|
|
|
|
int num = 0;
|
|
for (const Station *st : Station::Iterate()) {
|
|
if (st->town == t && (st->facilities & FACIL_AIRPORT) && st->airport.type != AT_OILRIG) num++;
|
|
}
|
|
return std::max(0, 2 - num);
|
|
}
|
|
|
|
/* static */ ScriptTown::RoadLayout ScriptTown::GetRoadLayout(TownID town_id)
|
|
{
|
|
if (!IsValidTown(town_id)) return ROAD_LAYOUT_INVALID;
|
|
|
|
return (ScriptTown::RoadLayout)((TownLayout)::Town::Get(town_id)->layout);
|
|
}
|