|
@@ -124,13 +124,13 @@ public:
|
|
|
};
|
|
|
|
|
|
/**
|
|
|
* Gets the number of towns.
|
|
|
* @return The number of towns.
|
|
|
*/
|
|
|
static int32 GetTownCount();
|
|
|
static SQInteger GetTownCount();
|
|
|
|
|
|
/**
|
|
|
* Checks whether the given town index is valid.
|
|
|
* @param town_id The index to check.
|
|
|
* @return True if and only if the town is valid.
|
|
|
*/
|
|
@@ -167,21 +167,21 @@ public:
|
|
|
/**
|
|
|
* Gets the number of inhabitants in the town.
|
|
|
* @param town_id The town to get the population of.
|
|
|
* @pre IsValidTown(town_id).
|
|
|
* @return The number of inhabitants.
|
|
|
*/
|
|
|
static int32 GetPopulation(TownID town_id);
|
|
|
static SQInteger GetPopulation(TownID town_id);
|
|
|
|
|
|
/**
|
|
|
* Gets the number of houses in the town.
|
|
|
* @param town_id The town to get the number of houses of.
|
|
|
* @pre IsValidTown(town_id).
|
|
|
* @return The number of houses.
|
|
|
*/
|
|
|
static int32 GetHouseCount(TownID town_id);
|
|
|
static SQInteger GetHouseCount(TownID town_id);
|
|
|
|
|
|
/**
|
|
|
* Gets the location of the town.
|
|
|
* @param town_id The town to get the location of.
|
|
|
* @pre IsValidTown(town_id).
|
|
|
* @return The location of the town.
|
|
@@ -193,68 +193,69 @@ public:
|
|
|
* @param town_id The index of the town.
|
|
|
* @param cargo_id The index of the cargo.
|
|
|
* @pre IsValidTown(town_id).
|
|
|
* @pre ScriptCargo::IsValidCargo(cargo_id).
|
|
|
* @return The last month's production of the given cargo for this town.
|
|
|
*/
|
|
|
static int32 GetLastMonthProduction(TownID town_id, CargoID cargo_id);
|
|
|
static SQInteger GetLastMonthProduction(TownID town_id, CargoID cargo_id);
|
|
|
|
|
|
/**
|
|
|
* Get the total amount of cargo supplied from a town last month.
|
|
|
* @param town_id The index of the town.
|
|
|
* @param cargo_id The index of the cargo.
|
|
|
* @pre IsValidTown(town_id).
|
|
|
* @pre ScriptCargo::IsValidCargo(cargo_id).
|
|
|
* @return The amount of cargo supplied for transport from this town last month.
|
|
|
*/
|
|
|
static int32 GetLastMonthSupplied(TownID town_id, CargoID cargo_id);
|
|
|
static SQInteger GetLastMonthSupplied(TownID town_id, CargoID cargo_id);
|
|
|
|
|
|
/**
|
|
|
* Get the percentage of transported production of the given cargo at a town.
|
|
|
* @param town_id The index of the town.
|
|
|
* @param cargo_id The index of the cargo.
|
|
|
* @pre IsValidTown(town_id).
|
|
|
* @pre ScriptCargo::IsValidCargo(cargo_id).
|
|
|
* @return The percentage of given cargo transported from this town last month.
|
|
|
*/
|
|
|
static int32 GetLastMonthTransportedPercentage(TownID town_id, CargoID cargo_id);
|
|
|
static SQInteger GetLastMonthTransportedPercentage(TownID town_id, CargoID cargo_id);
|
|
|
|
|
|
/**
|
|
|
* Get the total amount of cargo effects received by a town last month.
|
|
|
* @param town_id The index of the town.
|
|
|
* @param towneffect_id The index of the cargo.
|
|
|
* @pre IsValidTown(town_id).
|
|
|
* @pre ScriptCargo::IsValidTownEffect(cargo_id).
|
|
|
* @return The amount of cargo received by this town last month for this cargo effect.
|
|
|
*/
|
|
|
static int32 GetLastMonthReceived(TownID town_id, ScriptCargo::TownEffect towneffect_id);
|
|
|
static SQInteger GetLastMonthReceived(TownID town_id, ScriptCargo::TownEffect towneffect_id);
|
|
|
|
|
|
/**
|
|
|
* Set the goal of a cargo for this town.
|
|
|
* @param town_id The index of the town.
|
|
|
* @param towneffect_id The index of the towneffect.
|
|
|
* @param goal The new goal.
|
|
|
* The value will be clamped to 0 .. MAX(uint32).
|
|
|
* @pre IsValidTown(town_id).
|
|
|
* @pre ScriptCargo::IsValidTownEffect(towneffect_id).
|
|
|
* @return True if the action succeeded.
|
|
|
* @api -ai
|
|
|
*/
|
|
|
static bool SetCargoGoal(TownID town_id, ScriptCargo::TownEffect towneffect_id, uint32 goal);
|
|
|
static bool SetCargoGoal(TownID town_id, ScriptCargo::TownEffect towneffect_id, SQInteger goal);
|
|
|
|
|
|
/**
|
|
|
* Get the amount of cargo that needs to be delivered (per TownEffect) for a
|
|
|
* town to grow. All goals need to be reached before a town will grow.
|
|
|
* @param town_id The index of the town.
|
|
|
* @param towneffect_id The index of the towneffect.
|
|
|
* @pre IsValidTown(town_id).
|
|
|
* @pre ScriptCargo::IsValidTownEffect(towneffect_id).
|
|
|
* @return The goal of the cargo.
|
|
|
* @note Goals can change over time. For example with a changing snowline, or
|
|
|
* with a growing town.
|
|
|
*/
|
|
|
static uint32 GetCargoGoal(TownID town_id, ScriptCargo::TownEffect towneffect_id);
|
|
|
static SQInteger GetCargoGoal(TownID town_id, ScriptCargo::TownEffect towneffect_id);
|
|
|
|
|
|
/**
|
|
|
* Set the amount of days between town growth.
|
|
|
* @param town_id The index of the town.
|
|
|
* @param days_between_town_growth The amount of days between town growth, TOWN_GROWTH_NONE or TOWN_GROWTH_NORMAL.
|
|
|
* @pre IsValidTown(town_id).
|
|
@@ -262,42 +263,42 @@ public:
|
|
|
* @return True if the action succeeded.
|
|
|
* @note Even when setting a growth rate, towns only grow when the conditions for growth (SetCargoCoal) are met,
|
|
|
* and the game settings (economy.town_growth_rate) allow town growth at all.
|
|
|
* @note When changing the growth rate, the relative progress is preserved and scaled to the new rate.
|
|
|
* @api -ai
|
|
|
*/
|
|
|
static bool SetGrowthRate(TownID town_id, uint32 days_between_town_growth);
|
|
|
static bool SetGrowthRate(TownID town_id, SQInteger days_between_town_growth);
|
|
|
|
|
|
/**
|
|
|
* Get the amount of days between town growth.
|
|
|
* @param town_id The index of the town.
|
|
|
* @pre IsValidTown(town_id).
|
|
|
* @return Amount of days between town growth, or TOWN_GROWTH_NONE.
|
|
|
* @note This function does not indicate when it will grow next. It only tells you the time between growths.
|
|
|
*/
|
|
|
static int32 GetGrowthRate(TownID town_id);
|
|
|
static SQInteger GetGrowthRate(TownID town_id);
|
|
|
|
|
|
/**
|
|
|
* Get the manhattan distance from the tile to the ScriptTown::GetLocation()
|
|
|
* of the town.
|
|
|
* @param town_id The town to get the distance to.
|
|
|
* @param tile The tile to get the distance to.
|
|
|
* @pre IsValidTown(town_id).
|
|
|
* @return The distance between town and tile.
|
|
|
*/
|
|
|
static int32 GetDistanceManhattanToTile(TownID town_id, TileIndex tile);
|
|
|
static SQInteger GetDistanceManhattanToTile(TownID town_id, TileIndex tile);
|
|
|
|
|
|
/**
|
|
|
* Get the square distance from the tile to the ScriptTown::GetLocation()
|
|
|
* of the town.
|
|
|
* @param town_id The town to get the distance to.
|
|
|
* @param tile The tile to get the distance to.
|
|
|
* @pre IsValidTown(town_id).
|
|
|
* @return The distance between town and tile.
|
|
|
*/
|
|
|
static int32 GetDistanceSquareToTile(TownID town_id, TileIndex tile);
|
|
|
static SQInteger GetDistanceSquareToTile(TownID town_id, TileIndex tile);
|
|
|
|
|
|
/**
|
|
|
* Find out if this tile is within the rating influence of a town.
|
|
|
* If a station sign would be on this tile, the servicing quality of the station would
|
|
|
* influence the rating of the town.
|
|
|
* @param town_id The town to check.
|
|
@@ -328,22 +329,22 @@ public:
|
|
|
* Find out how long the town is undergoing road reconstructions.
|
|
|
* @param town_id The town to check.
|
|
|
* @pre IsValidTown(town_id).
|
|
|
* @return The number of months the road reworks are still going to take.
|
|
|
* The value 0 means that there are currently no road reworks.
|
|
|
*/
|
|
|
static int GetRoadReworkDuration(TownID town_id);
|
|
|
static SQInteger GetRoadReworkDuration(TownID town_id);
|
|
|
|
|
|
/**
|
|
|
* Find out how long new buildings are still being funded in a town.
|
|
|
* @param town_id The town to check.
|
|
|
* @pre IsValidTown(town_id).
|
|
|
* @return The number of months building construction is still funded.
|
|
|
* The value 0 means that there is currently no funding.
|
|
|
*/
|
|
|
static int GetFundBuildingsDuration(TownID town_id);
|
|
|
static SQInteger GetFundBuildingsDuration(TownID town_id);
|
|
|
|
|
|
/**
|
|
|
* Find out which company currently has the exclusive rights of this town.
|
|
|
* @param town_id The town to check.
|
|
|
* @pre IsValidTown(town_id).
|
|
|
* @game @pre Valid ScriptCompanyMode active in scope.
|
|
@@ -358,13 +359,13 @@ public:
|
|
|
* @param town_id The town to check.
|
|
|
* @pre IsValidTown(town_id).
|
|
|
* @return The number of months the exclusive rights hold.
|
|
|
* The value 0 means that there are currently no exclusive rights
|
|
|
* given out to anyone.
|
|
|
*/
|
|
|
static int32 GetExclusiveRightsDuration(TownID town_id);
|
|
|
static SQInteger GetExclusiveRightsDuration(TownID town_id);
|
|
|
|
|
|
/**
|
|
|
* Find out if an action can currently be performed on the town.
|
|
|
* @param town_id The town to perform the action on.
|
|
|
* @param town_action The action to perform on the town.
|
|
|
* @pre IsValidTown(town_id).
|
|
@@ -385,18 +386,19 @@ public:
|
|
|
static bool PerformTownAction(TownID town_id, TownAction town_action);
|
|
|
|
|
|
/**
|
|
|
* Expand the town.
|
|
|
* @param town_id The town to expand.
|
|
|
* @param houses The amount of houses to grow the town with.
|
|
|
* The value will be clamped to 0 .. MAX(uint32).
|
|
|
* @pre IsValidTown(town_id).
|
|
|
* @pre houses > 0.
|
|
|
* @return True if the action succeeded.
|
|
|
* @api -ai
|
|
|
*/
|
|
|
static bool ExpandTown(TownID town_id, int houses);
|
|
|
static bool ExpandTown(TownID town_id, SQInteger houses);
|
|
|
|
|
|
/**
|
|
|
* Found a new town.
|
|
|
* @param tile The location of the new town.
|
|
|
* @param size The town size of the new town.
|
|
|
* @param city True if the new town should be a city.
|
|
@@ -430,34 +432,34 @@ public:
|
|
|
* @param company_id The company to get the rating for.
|
|
|
* @pre IsValidTown(town_id).
|
|
|
* @pre ScriptCompany.ResolveCompanyID(company) != ScriptCompany::COMPANY_INVALID.
|
|
|
* @return The rating as a number between -1000 (worst) and 1000 (best).
|
|
|
* @api -ai
|
|
|
*/
|
|
|
static int GetDetailedRating(TownID town_id, ScriptCompany::CompanyID company_id);
|
|
|
static SQInteger GetDetailedRating(TownID town_id, ScriptCompany::CompanyID company_id);
|
|
|
|
|
|
/**
|
|
|
* Change the rating of a company within a town.
|
|
|
* @param town_id The town to change the rating in.
|
|
|
* @param company_id The company to change the rating for.
|
|
|
* @param delta How much to change rating by (range -1000 to +1000).
|
|
|
* @return True if the rating was changed.
|
|
|
* @pre IsValidTown(town_id).
|
|
|
* @pre ScriptCompany.ResolveCompanyID(company) != ScriptCompany::COMPANY_INVALID.
|
|
|
* @pre no company mode in scope
|
|
|
* @api -ai
|
|
|
*/
|
|
|
static bool ChangeRating(TownID town_id, ScriptCompany::CompanyID company_id, int delta);
|
|
|
static bool ChangeRating(TownID town_id, ScriptCompany::CompanyID company_id, SQInteger delta);
|
|
|
|
|
|
/**
|
|
|
* Get the maximum level of noise that still can be added by airports
|
|
|
* before the town start to refuse building a new airport.
|
|
|
* @param town_id The town to get the allowed noise from.
|
|
|
* @return The noise that still can be added.
|
|
|
*/
|
|
|
static int GetAllowedNoise(TownID town_id);
|
|
|
static SQInteger GetAllowedNoise(TownID town_id);
|
|
|
|
|
|
/**
|
|
|
* Get the road layout for a town.
|
|
|
* @param town_id The town to get the road layout from.
|
|
|
* @return The RoadLayout for the town.
|
|
|
*/
|