Changeset - r25961:cdb060badef0
[Not reviewed]
master
0 8 0
SamuXarick - 3 years ago 2021-09-14 20:06:55
43006711+SamuXarick@users.noreply.github.com
Feature: [AI/GS] Missing water related functions and objects (#8390)
8 files changed with 319 insertions and 61 deletions:
0 comments (0 inline, 0 general)
regression/regression/main.nut
Show inline comments
 
@@ -538,33 +538,36 @@ function Regression::Prices()
 
	print("  ROADTYPE_ROAD,BT_ROAD:       " + AIRoad.GetBuildCost(AIRoad.ROADTYPE_ROAD, AIRoad.BT_ROAD));
 
	print("  ROADTYPE_ROAD,BT_DEPOT:      " + AIRoad.GetBuildCost(AIRoad.ROADTYPE_ROAD, AIRoad.BT_DEPOT));
 
	print("  ROADTYPE_ROAD,BT_BUS_STOP:   " + AIRoad.GetBuildCost(AIRoad.ROADTYPE_ROAD, AIRoad.BT_BUS_STOP));
 
	print("  ROADTYPE_ROAD,BT_TRUCK_STOP: " + AIRoad.GetBuildCost(AIRoad.ROADTYPE_ROAD, AIRoad.BT_TRUCK_STOP));
 
	print("  ROADTYPE_TRAM,BT_ROAD:       " + AIRoad.GetBuildCost(AIRoad.ROADTYPE_TRAM, AIRoad.BT_ROAD));
 
	print("  ROADTYPE_TRAM,BT_DEPOT:      " + AIRoad.GetBuildCost(AIRoad.ROADTYPE_TRAM, AIRoad.BT_DEPOT));
 
	print("  ROADTYPE_TRAM,BT_BUS_STOP:   " + AIRoad.GetBuildCost(AIRoad.ROADTYPE_TRAM, AIRoad.BT_BUS_STOP));
 
	print("  ROADTYPE_TRAM,BT_TRUCK_STOP: " + AIRoad.GetBuildCost(AIRoad.ROADTYPE_TRAM, AIRoad.BT_TRUCK_STOP));
 
	print(" -Water-");
 
	print("  BT_DOCK:  " + AIMarine.GetBuildCost(AIMarine.BT_DOCK));
 
	print("  BT_DEPOT: " + AIMarine.GetBuildCost(AIMarine.BT_DEPOT));
 
	print("  BT_BUOY:  " + AIMarine.GetBuildCost(AIMarine.BT_BUOY));
 
	print("  BT_LOCK:  " + AIMarine.GetBuildCost(AIMarine.BT_LOCK));
 
	print("  BT_CANAL: " + AIMarine.GetBuildCost(AIMarine.BT_CANAL));
 
	print(" -Tile-");
 
	print("  BT_FOUNDATION:   " + AITile.GetBuildCost(AITile.BT_FOUNDATION));
 
	print("  BT_TERRAFORM:    " + AITile.GetBuildCost(AITile.BT_TERRAFORM));
 
	print("  BT_BUILD_TREES:  " + AITile.GetBuildCost(AITile.BT_BUILD_TREES));
 
	print("  BT_CLEAR_GRASS:  " + AITile.GetBuildCost(AITile.BT_CLEAR_GRASS));
 
	print("  BT_CLEAR_ROUGH:  " + AITile.GetBuildCost(AITile.BT_CLEAR_ROUGH));
 
	print("  BT_CLEAR_ROCKY:  " + AITile.GetBuildCost(AITile.BT_CLEAR_ROCKY));
 
	print("  BT_CLEAR_FIELDS: " + AITile.GetBuildCost(AITile.BT_CLEAR_FIELDS));
 
	print("  BT_CLEAR_HOUSE:  " + AITile.GetBuildCost(AITile.BT_CLEAR_HOUSE));
 
	print("  BT_CLEAR_WATER:  " + AITile.GetBuildCost(AITile.BT_CLEAR_WATER));
 
}
 

	
 
function cost_callback(old_path, new_tile, new_direction, self) { if (old_path == null) return 0; return old_path.GetCost() + 1; }
 
function estimate_callback(tile, direction, goals, self) { return goals[0] - tile; }
 
function neighbours_callback(path, cur_tile, self) { return [[cur_tile + 1, 1]]; }
 
function check_direction_callback(tile, existing_direction, new_direction, self) { return false; }
 

	
 
function Regression::Group()
 
{
 
	print ("");
 
	print("--Group--");
 
	print("  SetAutoReplace():         " + AIGroup.SetAutoReplace(AIGroup.GROUP_ALL, 116, 117));
 
@@ -910,24 +913,27 @@ function Regression::Marine()
 
	print("  RemoveBuoy():         " + AIMarine.RemoveBuoy(28481));
 
	print("  RemoveLock():         " + AIMarine.RemoveLock(28487));
 
	print("  RemoveCanal():        " + AIMarine.RemoveCanal(32127));
 
	print("  IsWaterDepotTile():   " + AIMarine.IsWaterDepotTile(28479));
 
	print("  IsDockTile():         " + AIMarine.IsDockTile(29253));
 
	print("  IsBuoyTile():         " + AIMarine.IsBuoyTile(28481));
 
	print("  IsLockTile():         " + AIMarine.IsLockTile(28487));
 
	print("  IsCanalTile():        " + AIMarine.IsCanalTile(32127));
 
	print("  GetBankBalance():     " + AICompany.GetBankBalance(AICompany.COMPANY_SELF));
 

	
 
	print("  BuildWaterDepot():    " + AIMarine.BuildWaterDepot(28479, 28480));
 
	print("  BuildDock():          " + AIMarine.BuildDock(29253, AIStation.STATION_JOIN_ADJACENT));
 
	print("  BuildBuoy():          " + AIMarine.BuildBuoy(28481));
 
	print("  BuildLock():          " + AIMarine.BuildLock(28487));
 
	print("  BuildCanal():         " + AIMarine.BuildCanal(28744));
 
}
 

	
 
function Regression::Order()
 
{
 
	print("");
 
	print("--Order--");
 
	print("  GetOrderCount():       " + AIOrder.GetOrderCount(12));
 
	print("  GetOrderDestination(): " + AIOrder.GetOrderDestination(12, 1));
 
	print("  AreOrderFlagsValid():  " + AIOrder.AreOrderFlagsValid(33416, AIOrder.OF_TRANSFER));
 
	print("  AreOrderFlagsValid():  " + AIOrder.AreOrderFlagsValid(33416, AIOrder.OF_TRANSFER | AIOrder.OF_UNLOAD));
 
	print("  AreOrderFlagsValid():  " + AIOrder.AreOrderFlagsValid(33416, AIOrder.OF_TRANSFER | AIOrder.OF_FULL_LOAD));
 
	print("  AreOrderFlagsValid():  " + AIOrder.AreOrderFlagsValid(33417, AIOrder.OF_SERVICE_IF_NEEDED));
 
@@ -1461,27 +1467,59 @@ function Regression::TileList()
 
	}
 

	
 
	list.Valuate(AIRoad.GetNeighbourRoadCount);
 
	list.KeepValue(1);
 
	print("  NeighbourRoadCount():done");
 
	print("  KeepValue(1):        done");
 
	print("  Count():             " + list.Count());
 
	print("  ListDump:");
 
	for (local i = list.Begin(); !list.IsEnd(); i = list.Next()) {
 
		print("    " + i + " => " + list.GetValue(i));
 
	}
 

	
 
	list.AddRectangle(54421 - 256 * 2, 256 * 2 + 54421 + 8);
 
	list.AddRectangle(0x6F3F, 0x7248);
 
	list.Valuate(AITile.IsWaterTile);
 
	print("  Water():             done");
 
	print("  IsWaterTile():       done");
 
	print("  Count():             " + list.Count());
 
	print("  ListDump:");
 
	for (local i = list.Begin(); !list.IsEnd(); i = list.Next()) {
 
		print("    " + i + " => " + list.GetValue(i));
 
	}
 

	
 
	list.Valuate(AITile.IsSeaTile);
 
	print("  IsSeaTile():         done");
 
	print("  Count():             " + list.Count());
 
	print("  ListDump:");
 
	for (local i = list.Begin(); !list.IsEnd(); i = list.Next()) {
 
		print("    " + i + " => " + list.GetValue(i));
 
	}
 

	
 
	list.Valuate(AITile.IsRiverTile);
 
	print("  IsRiverTile()        done");
 
	print("  Count():             " + list.Count());
 
	print("  ListDump:");
 
	for (local i = list.Begin(); !list.IsEnd(); i = list.Next()) {
 
		print("    " + i + " => " + list.GetValue(i));
 
	}
 

	
 
	list.Valuate(AIMarine.IsCanalTile);
 
	print("  IsCanalTile()        done");
 
	print("  Count():             " + list.Count());
 
	print("  ListDump:");
 
	for (local i = list.Begin(); !list.IsEnd(); i = list.Next()) {
 
		print("    " + i + " => " + list.GetValue(i));
 
	}
 

	
 
	list.Valuate(AITile.IsCoastTile);
 
	print("  IsCoastTile()        done");
 
	print("  Count():             " + list.Count());
 
	print("  ListDump:");
 
	for (local i = list.Begin(); !list.IsEnd(); i = list.Next()) {
 
		print("    " + i + " => " + list.GetValue(i));
 
	}
 

	
 
	list = AITileList_IndustryAccepting(0, 3);
 
	print("");
 
	print("--TileList_IndustryAccepting--");
 
	print("  Count():             " + list.Count());
 
	list.Valuate(AITile.GetCargoAcceptance, 3, 1, 1, 3);
 
	print("  Location ListDump:");
regression/regression/result.txt
Show inline comments
 
@@ -7356,24 +7356,27 @@ ERROR: IsEnd() is invalid as Begin() is 
 
  RemoveDock():         true
 
  RemoveBuoy():         true
 
  RemoveLock():         true
 
  RemoveCanal():        true
 
  IsWaterDepotTile():   false
 
  IsDockTile():         false
 
  IsBuoyTile():         false
 
  IsLockTile():         false
 
  IsCanalTile():        false
 
  GetBankBalance():     1999959285
 
  BuildWaterDepot():    true
 
  BuildDock():          true
 
  BuildBuoy():          true
 
  BuildLock():          true
 
  BuildCanal():         true
 

	
 
--Prices--
 
 -Rail-
 
  0,BT_TRACK:    75
 
  0,BT_SIGNAL:   48
 
  0,BT_DEPOT:    450
 
  0,BT_STATION:  285
 
  0,BT_WAYPOINT: 450
 
  1,BT_TRACK:    -1
 
  1,BT_SIGNAL:   -1
 
  1,BT_DEPOT:    -1
 
  1,BT_STATION:  -1
 
@@ -7382,33 +7385,36 @@ ERROR: IsEnd() is invalid as Begin() is 
 
  ROADTYPE_ROAD,BT_ROAD:       71
 
  ROADTYPE_ROAD,BT_DEPOT:      375
 
  ROADTYPE_ROAD,BT_BUS_STOP:   150
 
  ROADTYPE_ROAD,BT_TRUCK_STOP: 150
 
  ROADTYPE_TRAM,BT_ROAD:       -1
 
  ROADTYPE_TRAM,BT_DEPOT:      -1
 
  ROADTYPE_TRAM,BT_BUS_STOP:   -1
 
  ROADTYPE_TRAM,BT_TRUCK_STOP: -1
 
 -Water-
 
  BT_DOCK:  262
 
  BT_DEPOT: 525
 
  BT_BUOY:  262
 
  BT_LOCK:  5625
 
  BT_CANAL: 3750
 
 -Tile-
 
  BT_FOUNDATION:   187
 
  BT_TERRAFORM:    187
 
  BT_BUILD_TREES:  15
 
  BT_CLEAR_GRASS:  15
 
  BT_CLEAR_ROUGH:  30
 
  BT_CLEAR_ROCKY:  150
 
  BT_CLEAR_FIELDS: 375
 
  BT_CLEAR_HOUSE:  1200
 
  BT_CLEAR_WATER:  7500
 

	
 
--Rail--
 
    IsRailTile():                  false
 
    BuildRailTrack():              true
 
    BuildSignal():                 true
 
    RemoveRailTrack():             false
 
    RemoveRailTrack():             true
 
    BuildRail():                   true
 
    HasTransportType():            true
 
    HasTransportType():            false
 
    RemoveRail():                  true
 
    HasTransportType():            false
 
@@ -8441,72 +8447,239 @@ ERROR: IsEnd() is invalid as Begin() is 
 
    42411 => 13
 
    42410 => 13
 
    42155 => 13
 
    42154 => 13
 
  RoadTile():          done
 
  KeepValue(1):        done
 
  Count():             0
 
  ListDump:
 
  NeighbourRoadCount():done
 
  KeepValue(1):        done
 
  Count():             0
 
  ListDump:
 
  Water():             done
 
  Count():             45
 
  IsWaterTile():       done
 
  Count():             40
 
  ListDump:
 
    29251 => 1
 
    29250 => 1
 
    29249 => 1
 
    29248 => 1
 
    29247 => 1
 
    28996 => 1
 
    28995 => 1
 
    28994 => 1
 
    28993 => 1
 
    28992 => 1
 
    28991 => 1
 
    28744 => 1
 
    28741 => 1
 
    28740 => 1
 
    28739 => 1
 
    28738 => 1
 
    28737 => 1
 
    28736 => 1
 
    28735 => 1
 
    28488 => 1
 
    28487 => 1
 
    28486 => 1
 
    28485 => 1
 
    28484 => 1
 
    28483 => 1
 
    28482 => 1
 
    28480 => 1
 
    28479 => 1
 
    29256 => 0
 
    29255 => 0
 
    29254 => 0
 
    29253 => 0
 
    29252 => 0
 
    29000 => 0
 
    28999 => 0
 
    28998 => 0
 
    28997 => 0
 
    28743 => 0
 
    28742 => 0
 
    28481 => 0
 
  IsSeaTile():         done
 
  Count():             40
 
  ListDump:
 
    29251 => 1
 
    29250 => 1
 
    29249 => 1
 
    29248 => 1
 
    29247 => 1
 
    28996 => 1
 
    28995 => 1
 
    28994 => 1
 
    28993 => 1
 
    28992 => 1
 
    28991 => 1
 
    28741 => 1
 
    28740 => 1
 
    28739 => 1
 
    28738 => 1
 
    28737 => 1
 
    28736 => 1
 
    28735 => 1
 
    28485 => 1
 
    28484 => 1
 
    28483 => 1
 
    28482 => 1
 
    29256 => 0
 
    29255 => 0
 
    29254 => 0
 
    29253 => 0
 
    29252 => 0
 
    29000 => 0
 
    28999 => 0
 
    28998 => 0
 
    28997 => 0
 
    28744 => 0
 
    28743 => 0
 
    28742 => 0
 
    28488 => 0
 
    28487 => 0
 
    28486 => 0
 
    28481 => 0
 
    28480 => 0
 
    28479 => 0
 
  IsRiverTile()        done
 
  Count():             40
 
  ListDump:
 
    54941 => 1
 
    54940 => 1
 
    54939 => 1
 
    54938 => 1
 
    54937 => 1
 
    54936 => 1
 
    54935 => 1
 
    54934 => 1
 
    54933 => 1
 
    54685 => 1
 
    54684 => 1
 
    54683 => 1
 
    54682 => 1
 
    54681 => 1
 
    54680 => 1
 
    54679 => 1
 
    54678 => 1
 
    54677 => 1
 
    54429 => 1
 
    54428 => 1
 
    54427 => 1
 
    54426 => 1
 
    54425 => 1
 
    54424 => 1
 
    54423 => 1
 
    54422 => 1
 
    54421 => 1
 
    54173 => 1
 
    54172 => 1
 
    54171 => 1
 
    54170 => 1
 
    54169 => 1
 
    54168 => 0
 
    54167 => 0
 
    54166 => 0
 
    54165 => 0
 
    53917 => 0
 
    53916 => 0
 
    53915 => 0
 
    53914 => 0
 
    53913 => 0
 
    53912 => 0
 
    53911 => 0
 
    53910 => 0
 
    53909 => 0
 
    29256 => 0
 
    29255 => 0
 
    29254 => 0
 
    29253 => 0
 
    29252 => 0
 
    29251 => 0
 
    29250 => 0
 
    29249 => 0
 
    29248 => 0
 
    29247 => 0
 
    29000 => 0
 
    28999 => 0
 
    28998 => 0
 
    28997 => 0
 
    28996 => 0
 
    28995 => 0
 
    28994 => 0
 
    28993 => 0
 
    28992 => 0
 
    28991 => 0
 
    28744 => 0
 
    28743 => 0
 
    28742 => 0
 
    28741 => 0
 
    28740 => 0
 
    28739 => 0
 
    28738 => 0
 
    28737 => 0
 
    28736 => 0
 
    28735 => 0
 
    28488 => 0
 
    28487 => 0
 
    28486 => 0
 
    28485 => 0
 
    28484 => 0
 
    28483 => 0
 
    28482 => 0
 
    28481 => 0
 
    28480 => 0
 
    28479 => 0
 
  IsCanalTile()        done
 
  Count():             40
 
  ListDump:
 
    28744 => 1
 
    29256 => 0
 
    29255 => 0
 
    29254 => 0
 
    29253 => 0
 
    29252 => 0
 
    29251 => 0
 
    29250 => 0
 
    29249 => 0
 
    29248 => 0
 
    29247 => 0
 
    29000 => 0
 
    28999 => 0
 
    28998 => 0
 
    28997 => 0
 
    28996 => 0
 
    28995 => 0
 
    28994 => 0
 
    28993 => 0
 
    28992 => 0
 
    28991 => 0
 
    28743 => 0
 
    28742 => 0
 
    28741 => 0
 
    28740 => 0
 
    28739 => 0
 
    28738 => 0
 
    28737 => 0
 
    28736 => 0
 
    28735 => 0
 
    28488 => 0
 
    28487 => 0
 
    28486 => 0
 
    28485 => 0
 
    28484 => 0
 
    28483 => 0
 
    28482 => 0
 
    28481 => 0
 
    28480 => 0
 
    28479 => 0
 
  IsCoastTile()        done
 
  Count():             40
 
  ListDump:
 
    28998 => 1
 
    28997 => 1
 
    28743 => 1
 
    28742 => 1
 
    29256 => 0
 
    29255 => 0
 
    29254 => 0
 
    29253 => 0
 
    29252 => 0
 
    29251 => 0
 
    29250 => 0
 
    29249 => 0
 
    29248 => 0
 
    29247 => 0
 
    29000 => 0
 
    28999 => 0
 
    28996 => 0
 
    28995 => 0
 
    28994 => 0
 
    28993 => 0
 
    28992 => 0
 
    28991 => 0
 
    28744 => 0
 
    28741 => 0
 
    28740 => 0
 
    28739 => 0
 
    28738 => 0
 
    28737 => 0
 
    28736 => 0
 
    28735 => 0
 
    28488 => 0
 
    28487 => 0
 
    28486 => 0
 
    28485 => 0
 
    28484 => 0
 
    28483 => 0
 
    28482 => 0
 
    28481 => 0
 
    28480 => 0
 
    28479 => 0
 

	
 
--TileList_IndustryAccepting--
 
  Count():             47
 
  Location ListDump:
 
    21234 => 16
 
    21233 => 16
 
    21232 => 16
 
    21231 => 16
 
    21230 => 16
 
    21229 => 16
 
    20978 => 16
 
    20977 => 16
 
@@ -9090,67 +9263,67 @@ ERROR: IsEnd() is invalid as Begin() is 
 
  IsStoppedInDepot():   false
 
  --Accounting--
 
    GetCosts():         -5947
 
    Should be:          -5947
 
  GetName():            Road Vehicle #1
 
  SetName():            true
 
  GetName():            MyVehicleName
 
  CloneVehicle():       13
 
  --VehicleData--
 
    GetLocation():       33417
 
    GetEngineType():     153
 
    GetUnitNumber():     1
 
    GetAge():            0
 
    GetAge():            1
 
    GetMaxAge():         5490
 
    GetAgeLeft():        5490
 
    GetAgeLeft():        5489
 
    GetCurrentSpeed():   7
 
    GetRunningCost():    421
 
    GetProfitThisYear(): 0
 
    GetProfitThisYear(): -1
 
    GetProfitLastYear(): 0
 
    GetCurrentValue():   5947
 
    GetVehicleType():    1
 
    GetRoadType():       0
 
    GetCapacity():       12
 
    GetCargoLoad():      0
 
    IsInDepot():         false
 
    GetNumWagons():      1
 
    GetWagonEngineType(): 153
 
    GetWagonAge():       0
 
    GetWagonAge():       1
 
    GetLength():         8
 
  GetOwner():           1
 
  BuildVehicle():       14
 
  IsValidVehicle(14):   true
 
  IsInDepot(14):        true
 
  IsStoppedInDepot(14): true
 
  IsValidVehicle(15):   false
 
  IsInDepot(15):        false
 
  IsStoppedInDepot(15): false
 
  BuildVehicle():       16
 
  IsValidVehicle(16):   true
 
  IsInDepot(16):        true
 
  IsStoppedInDepot(16): true
 
  BuildRailDepot():     true
 
  BuildVehicle():       17
 
  BuildVehicle():       18
 
  BuildVehicle():       19
 
  IsValidVehicle(17):   true
 
  IsValidVehicle(18):   true
 
  IsValidVehicle(19):   false
 
  MoveWagonChain():     true
 
  GetNumWagons():       3
 
  GetLength():          24
 
  GetWagonEngineType(): 9
 
  GetWagonAge():        1
 
  GetWagonAge():        0
 
  GetWagonEngineType(): 27
 
  GetWagonAge():        1
 
  GetWagonAge():        0
 
  GetWagonEngineType(): 27
 
  GetWagonAge():        0
 
  GetWagonEngineType(): 65535
 
  GetWagonAge():        -1
 
  --Refit--
 
    GetBuildWithRefitCapacity(): -1
 
    GetBuildWithRefitCapacity(): 0
 
    GetBuildWithRefitCapacity(): 160
 
    BuildVehicleWithRefit():     20
 
    GetCapacity():               160
 
    GetCapacity():               0
 
    GetRefitCapacity():          160
 
@@ -9178,39 +9351,39 @@ ERROR: IsEnd() is invalid as Begin() is 
 
    14 => 219
 
    16 => 204
 
    13 => 153
 
    12 => 153
 
    17 => 9
 
  UnitNumber ListDump:
 
    13 => 2
 
    17 => 1
 
    16 => 1
 
    14 => 1
 
    12 => 1
 
  Age ListDump:
 
    17 => 1
 
    16 => 1
 
    14 => 1
 
    13 => 1
 
    12 => 1
 
    17 => 0
 
    16 => 0
 
    14 => 0
 
  MaxAge ListDump:
 
    16 => 10980
 
    14 => 10980
 
    17 => 7320
 
    13 => 5490
 
    12 => 5490
 
  AgeLeft ListDump:
 
    16 => 10979
 
    14 => 10979
 
    17 => 7319
 
    16 => 10980
 
    14 => 10980
 
    17 => 7320
 
    13 => 5489
 
    12 => 5489
 
  CurrentSpeed ListDump:
 
    12 => 27
 
    17 => 0
 
    16 => 0
 
    14 => 0
 
    13 => 0
 
  RunningCost ListDump:
 
    14 => 2756
 
    17 => 2296
 
    16 => 2296
src/script/api/ai_changelog.hpp
Show inline comments
 
@@ -12,24 +12,29 @@
 
 * bug fixes can be found in the normal changelog. Note that removed API
 
 * functions may still be available if you return an older API version
 
 * in GetAPIVersion() in info.nut.
 
 *
 
 * \b 12.0
 
 *
 
 * This version is not yet released. The following changes are not set in stone yet.
 
 *
 
 * API additions:
 
 * \li AINewGRF
 
 * \li AINewGRFList
 
 * \li AIGroup::GetNumVehicles
 
 * \li AIMarine::BT_LOCK
 
 * \li AIMarine::BT_CANAL
 
 * \li AITile::IsSeaTile
 
 * \li AITile::IsRiverTile
 
 * \li AITile::BT_CLEAR_WATER
 
 *
 
 * \b 1.11.0
 
 *
 
 * API additions:
 
 * \li AICargo::GetName
 
 * \li AIPriorityQueue
 
 *
 
 * Other changes:
 
 * \li AIVehicle::CloneVehicle now correctly returns estimate when short on cash
 
 *
 
 * \b 1.10.0
 
 *
src/script/api/game_changelog.hpp
Show inline comments
 
@@ -11,24 +11,29 @@
 
 * Only new / renamed / deleted api functions will be listed here. A list of
 
 * bug fixes can be found in the normal changelog. Note that removed API
 
 * functions may still be available if you return an older API version
 
 * in GetAPIVersion() in info.nut.
 
 *
 
 * \b 12.0
 
 *
 
 * This version is not yet released. The following changes are not set in stone yet.
 
 *
 
 * API additions:
 
 * \li GSNewGRF
 
 * \li GSNewGRFList
 
 * \li GSMarine::BT_LOCK
 
 * \li GSMarine::BT_CANAL
 
 * \li GSTile::IsSeaTile
 
 * \li GSTile::IsRiverTile
 
 * \li GSTile::BT_CLEAR_WATER
 
 *
 
 * \b 1.11.0
 
 *
 
 * API additions:
 
 * \li GSCargo::GetName
 
 * \li GSEventStoryPageButtonClick
 
 * \li GSEventStoryPageTileSelect
 
 * \li GSEventStoryPageVehicleSelect
 
 * \li GSIndustry::GetCargoLastAcceptedDate
 
 * \li GSIndustry::GetControlFlags
 
 * \li GSIndustry::GetExclusiveConsumer
 
 * \li GSIndustry::GetExclusiveSupplier
src/script/api/script_marine.cpp
Show inline comments
 
@@ -158,15 +158,17 @@
 
	EnforcePrecondition(false, ::IsValidTile(tile));
 
	EnforcePrecondition(false, IsCanalTile(tile));
 

	
 
	return ScriptObject::DoCommand(tile, 0, 0, CMD_LANDSCAPE_CLEAR);
 
}
 

	
 
/* static */ Money ScriptMarine::GetBuildCost(BuildType build_type)
 
{
 
	switch (build_type) {
 
		case BT_DOCK:  return ::GetPrice(PR_BUILD_STATION_DOCK, 1, nullptr);
 
		case BT_DEPOT: return ::GetPrice(PR_BUILD_DEPOT_SHIP, 1, nullptr);
 
		case BT_BUOY:  return ::GetPrice(PR_BUILD_WAYPOINT_BUOY, 1, nullptr);
 
		case BT_LOCK:  return ::GetPrice(PR_BUILD_LOCK, 1, nullptr);
 
		case BT_CANAL: return ::GetPrice(PR_BUILD_CANAL, 1, nullptr);
 
		default: return -1;
 
	}
 
}
src/script/api/script_marine.hpp
Show inline comments
 
@@ -27,24 +27,26 @@ public:
 

	
 
		/** Infrastructure must be built on water */
 
		ERR_MARINE_MUST_BE_BUILT_ON_WATER,                  // [STR_ERROR_MUST_BE_BUILT_ON_WATER]
 
	};
 

	
 
	/**
 
	 * Types of water-related objects in the game.
 
	 */
 
	enum BuildType {
 
		BT_DOCK,  ///< Build a dock
 
		BT_DEPOT, ///< Build a ship depot
 
		BT_BUOY,  ///< Build a buoy
 
		BT_LOCK,  ///< Build a lock
 
		BT_CANAL, ///< Build a canal
 
	};
 

	
 
	/**
 
	 * Checks whether the given tile is actually a tile with a water depot.
 
	 * @param tile The tile to check.
 
	 * @pre ScriptMap::IsValidTile(tile).
 
	 * @return True if and only if the tile has a water depot.
 
	 */
 
	static bool IsWaterDepotTile(TileIndex tile);
 

	
 
	/**
 
	 * Checks whether the given tile is actually a tile with a dock.
src/script/api/script_tile.cpp
Show inline comments
 
@@ -49,24 +49,38 @@
 
	uint tx = ScriptMap::GetTileX(tile);
 
	uint ty = ScriptMap::GetTileY(tile);
 

	
 
	for (uint x = tx; x < width + tx; x++) {
 
		for (uint y = ty; y < height + ty; y++) {
 
			if (!IsBuildable(ScriptMap::GetTileIndex(x, y))) return false;
 
		}
 
	}
 

	
 
	return true;
 
}
 

	
 
/* static */ bool ScriptTile::IsSeaTile(TileIndex tile)
 
{
 
	if (!::IsValidTile(tile)) return false;
 

	
 
	return ::IsTileType(tile, MP_WATER) && ::IsSea(tile);
 
}
 

	
 
/* static */ bool ScriptTile::IsRiverTile(TileIndex tile)
 
{
 
	if (!::IsValidTile(tile)) return false;
 

	
 
	return ::IsTileType(tile, MP_WATER) && ::IsRiver(tile);
 
}
 

	
 
/* static */ bool ScriptTile::IsWaterTile(TileIndex tile)
 
{
 
	if (!::IsValidTile(tile)) return false;
 

	
 
	return ::IsTileType(tile, MP_WATER) && !::IsCoast(tile);
 
}
 

	
 
/* static */ bool ScriptTile::IsCoastTile(TileIndex tile)
 
{
 
	if (!::IsValidTile(tile)) return false;
 

	
 
	return (::IsTileType(tile, MP_WATER) && ::IsCoast(tile)) ||
 
@@ -311,15 +325,16 @@
 

	
 
/* static */ Money ScriptTile::GetBuildCost(BuildType build_type)
 
{
 
	switch (build_type) {
 
		case BT_FOUNDATION:   return ::GetPrice(PR_BUILD_FOUNDATION, 1, nullptr);
 
		case BT_TERRAFORM:    return ::GetPrice(PR_TERRAFORM, 1, nullptr);
 
		case BT_BUILD_TREES:  return ::GetPrice(PR_BUILD_TREES, 1, nullptr);
 
		case BT_CLEAR_GRASS:  return ::GetPrice(PR_CLEAR_GRASS, 1, nullptr);
 
		case BT_CLEAR_ROUGH:  return ::GetPrice(PR_CLEAR_ROUGH, 1, nullptr);
 
		case BT_CLEAR_ROCKY:  return ::GetPrice(PR_CLEAR_ROCKS, 1, nullptr);
 
		case BT_CLEAR_FIELDS: return ::GetPrice(PR_CLEAR_FIELDS, 1, nullptr);
 
		case BT_CLEAR_HOUSE:  return ::GetPrice(PR_CLEAR_HOUSE, 1, nullptr);
 
		case BT_CLEAR_WATER:  return ::GetPrice(PR_CLEAR_WATER, 1, nullptr);
 
		default: return -1;
 
	}
 
}
src/script/api/script_tile.hpp
Show inline comments
 
@@ -110,24 +110,25 @@ public:
 
	/**
 
	 * Get the base cost for building/clearing several things.
 
	 */
 
	enum BuildType {
 
		BT_FOUNDATION,   ///< Build a foundation under something
 
		BT_TERRAFORM,    ///< Terraform
 
		BT_BUILD_TREES,  ///< Build trees
 
		BT_CLEAR_GRASS,  ///< Clear a tile with just grass
 
		BT_CLEAR_ROUGH,  ///< Clear a rough tile
 
		BT_CLEAR_ROCKY,  ///< Clear a tile with rocks
 
		BT_CLEAR_FIELDS, ///< Clear a tile with farm fields
 
		BT_CLEAR_HOUSE,  ///< Clear a tile with a house
 
		BT_CLEAR_WATER,  ///< Clear a tile with either river or sea
 
	};
 

	
 
	/**
 
	 * The types of terrain a tile can have.
 
	 *
 
	 * @note When a desert or rainforest tile are changed, their terrain type will remain the same. In other words, a sea tile can be of the desert terrain type.
 
	 * @note The snow terrain type can change to the normal terrain type and vice versa based on landscaping or variable snow lines from NewGRFs.
 
	 */
 
	enum TerrainType {
 
		TERRAIN_NORMAL,     ///< A normal tile (default); not desert, rainforest or snow.
 
		TERRAIN_DESERT,     ///< A tile in the desert (manually set in in scenarios, below certain height and certain distance from water in random games).
 
		TERRAIN_RAINFOREST, ///< A tile in the rainforest (manually set in scenarios, certain distance away from deserts in random games),
 
@@ -150,28 +151,45 @@ public:
 
	/**
 
	 * Check if this tile is buildable in a rectangle around a tile, with the
 
	 *  entry in the list as top-left.
 
	 * @param tile The tile to check on.
 
	 * @param width The width of the rectangle.
 
	 * @param height The height of the rectangle.
 
	 * @pre ScriptMap::IsValidTile(tile).
 
	 * @return True if it is buildable, false if not.
 
	 */
 
	static bool IsBuildableRectangle(TileIndex tile, uint width, uint height);
 

	
 
	/**
 
	 * Checks whether the given tile is actually a sea tile.
 
	 * @param tile The tile to check on.
 
	 * @pre ScriptMap::IsValidTile(tile).
 
	 * @return True if and only if the tile is a sea tile.
 
	 */
 
	static bool IsSeaTile(TileIndex tile);
 

	
 
	/**
 
	 * Checks whether the given tile is actually a river tile.
 
	 * @param tile The tile to check on.
 
	 * @pre ScriptMap::IsValidTile(tile).
 
	 * @return True if and only if the tile is a river tile.
 
	 */
 
	static bool IsRiverTile(TileIndex tile);
 

	
 
	/**
 
	 * Checks whether the given tile is actually a water tile.
 
	 * @param tile The tile to check on.
 
	 * @pre ScriptMap::IsValidTile(tile).
 
	 * @return True if and only if the tile is a water tile.
 
	 * @note Returns false when a buoy is on the tile.
 
	 */
 
	static bool IsWaterTile(TileIndex tile);
 

	
 
	/**
 
	 * Checks whether the given tile is actually a coast tile.
 
	 * @param tile The tile to check.
 
	 * @pre ScriptMap::IsValidTile(tile).
 
	 * @return True if and only if the tile is a coast tile.
 
	 * @note Building on coast tiles in general is more expensive. This is not
 
	 *  true if there are also trees on the tile, see #HasTreeOnTile.
 
	 */
 
	static bool IsCoastTile(TileIndex tile);
0 comments (0 inline, 0 general)