openttd-ottdgrfs: comparison src/waypoint.cpp

equal deleted inserted replaced

-:3b068c3a1c74
+:0fa543611bbe
 /* $Id$ */
+/** @file waypoint.cpp */
 #include "stdafx.h"
 #include "openttd.h"
 #include "command.h"
 #include "functions.h"
 #include "gfx.h"
+#include "landscape.h"
 #include "map.h"
 #include "order.h"
 #include "rail_map.h"
 #include "bridge_map.h"
 #include "saveload.h"
 #include "variables.h"
 #include "table/strings.h"
 #include "vehicle.h"
 #include "yapf/yapf.h"
 #include "date.h"
+#include "newgrf.h"
 enum {
 	MAX_WAYPOINTS_PER_TOWN = 64,
 };
 	for (wp = GetWaypoint(start_item); wp != NULL; wp = (wp->index + 1U < GetWaypointPoolSize()) ? GetWaypoint(wp->index + 1U) : NULL) wp->index = start_item++;
 }
 DEFINE_OLD_POOL(Waypoint, Waypoint, WaypointPoolNewBlock, NULL)
-/* Create a new waypoint */
+/**
+* Create a new waypoint
+* @return a pointer to the newly created Waypoint */
 static Waypoint* AllocateWaypoint()
 {
 	Waypoint *wp;
 	/* We don't use FOR_ALL here, because FOR_ALL skips invalid items.
 	if (AddBlockToPool(&_Waypoint_pool)) return AllocateWaypoint();
 	return NULL;
 }
-/* Update the sign for the waypoint */
+/**
+* Update the sign for the waypoint
+* @param wp Waypoint to update sign */
 static void UpdateWaypointSign(Waypoint* wp)
 {
 	Point pt = RemapCoords2(TileX(wp->xy) * TILE_SIZE, TileY(wp->xy) * TILE_SIZE);
 	SetDParam(0, wp->index);
 	UpdateViewportSignPos(&wp->sign, pt.x, pt.y - 0x20, STR_WAYPOINT_VIEWPORT);
 }
-/* Redraw the sign of a waypoint */
+/**
+* Redraw the sign of a waypoint
+* @param wp Waypoint to redraw sign */
 static void RedrawWaypointSign(const Waypoint* wp)
 {
 	MarkAllViewportsDirty(
 		wp->sign.left - 6,
 		wp->sign.top,
 		wp->sign.left + (wp->sign.width_1 << 2) + 12,
 		wp->sign.top + 48);
 }
-/* Update all signs */
+/**
+* Update all signs
+*/
 void UpdateAllWaypointSigns()
 {
 	Waypoint *wp;
 	FOR_ALL_WAYPOINTS(wp) {
 		UpdateWaypointSign(wp);
 	}
 }
-/* Internal handler to delete a waypoint */
+/**
+* Internal handler to delete a waypoint
+* @param wp Waypoint to delete
+*/
 void DestroyWaypoint(Waypoint *wp)
 {
 	RemoveOrderFromAllVehicles(OT_GOTO_WAYPOINT, wp->index);
 	if (wp->string != STR_NULL) DeleteName(wp->string);
 	RedrawWaypointSign(wp);
 }
-/* Set the default name for a waypoint */
+/**
+* Set the default name for a waypoint
+* @param wp Waypoint to work on
+*/
 static void MakeDefaultWaypointName(Waypoint* wp)
 {
 	Waypoint *local_wp;
 	bool used_waypoint[MAX_WAYPOINTS_PER_TOWN];
 	int i;
 	wp->string = STR_NULL;
 	wp->town_cn = i;
 }
-/* Find a deleted waypoint close to a tile. */
+/**
+* Find a deleted waypoint close to a tile.
+* @param tile to search from
+*/
 static Waypoint *FindDeletedWaypointCloseTo(TileIndex tile)
 {
 	Waypoint *wp, *best = NULL;
 	uint thres = 8;
 		if (wp->grfid == 0) continue;
 		for (i = 0; i < GetNumCustomStations(STAT_CLASS_WAYP); i++) {
 			const StationSpec *statspec = GetCustomStationSpec(STAT_CLASS_WAYP, i);
-			if (statspec != NULL && statspec->grfid == wp->grfid && statspec->localidx == wp->localidx) {
+			if (statspec != NULL && statspec->grffile->grfid == wp->grfid && statspec->localidx == wp->localidx) {
 				wp->stat_id = i;
 				break;
 			}
 		}
 	}
 }
 /** Convert existing rail to waypoint. Eg build a waypoint station over
 * piece of rail
 * @param tile tile where waypoint will be built
+* @param flags type of operation
 * @param p1 graphics for waypoint type, 0 indicates standard graphics
 * @param p2 unused
 *
 * @todo When checking for the tile slope,
 * distingush between "Flat land required" and "land sloped in wrong direction"
 		statspec = GetCustomStationSpec(STAT_CLASS_WAYP, p1);
 		if (statspec != NULL) {
 			wp->stat_id = p1;
-			wp->grfid = statspec->grfid;
+			wp->grfid = statspec->grffile->grfid;
 			wp->localidx = statspec->localidx;
 		} else {
-			// Specified custom graphics do not exist, so use default.
+			/* Specified custom graphics do not exist, so use default. */
 			wp->stat_id = 0;
 			wp->grfid = 0;
 			wp->localidx = 0;
 		}
 	}
 	return _eco->GetPrice(CEconomy::BUILD_TRAIN_DEPOT);
 }
-/* Daily loop for waypoints */
+/**
+* Daily loop for waypoints
+*/
 void WaypointsDailyLoop()
 {
 	Waypoint *wp;
 	/* Check if we need to delete a waypoint */
 	FOR_ALL_WAYPOINTS(wp) {
 		if (wp->deleted != 0 && --wp->deleted == 0) DeleteWaypoint(wp);
 	}
 }
-/* Remove a waypoint */
+/**
+* Remove a waypoint
+* @param tile from which to remove waypoint
+* @param flags type of operation
+* @param justremove will indicate if it is removed from rail or if rails are removed too
+* @return cost of operation or error
+*/
 int32 RemoveTrainWaypoint(TileIndex tile, uint32 flags, bool justremove)
 {
 	Waypoint *wp;
 	/* Make sure it's a waypoint */
 	}
 	return _eco->GetPrice(CEconomy::REMOVE_TRAIN_DEPOT);
 }
-/** Delete a waypoint
+/**
+* Delete a waypoint
 * @param tile tile where waypoint is to be deleted
+* @param flags type of operation
 * @param p1 unused
 * @param p2 unused
+* @return cost of operation or error
 */
 int32 CmdRemoveTrainWaypoint(TileIndex tile, uint32 flags, uint32 p1, uint32 p2)
 {
 	SET_EXPENSES_TYPE(EXPENSES_CONSTRUCTION);
 	return RemoveTrainWaypoint(tile, flags, true);
 }
-/** Rename a waypoint.
+/**
+* Rename a waypoint.
 * @param tile unused
+* @param flags type of operation
 * @param p1 id of waypoint
 * @param p2 unused
+* @return cost of operation or error
 */
 int32 CmdRenameWaypoint(TileIndex tile, uint32 flags, uint32 p1, uint32 p2)
 {
 	Waypoint *wp;
 		}
 	}
 	return 0;
 }
-/* This hacks together some dummy one-shot Station structure for a waypoint. */
+/**
+* This hacks together some dummy one-shot Station structure for a waypoint.
+* @param tile on which to work
+* @return pointer to a Station
+*/
 Station *ComposeWaypointStation(TileIndex tile)
 {
 	Waypoint *wp = GetWaypointByTile(tile);
 	/* instead of 'static Station stat' use byte array to avoid Station's destructor call upon exit. As
 	stat.build_date = wp->build_date;
 	return &stat;
 }
-/* Draw a waypoint */
+/**
+* Draw a waypoint
+* @param x coordinate
+* @param y coordinate
+* @param stat_id station id
+* @param railtype RailType to use for
+*/
 void DrawWaypointSprite(int x, int y, int stat_id, RailType railtype)
 {
 	x += 33;
 	y += 17;
 	if (!DrawStationTile(x, y, railtype, AXIS_X, STAT_CLASS_WAYP, stat_id)) {
 		DrawDefaultWaypointSprite(x, y, railtype);
 	}
 }
-/* Fix savegames which stored waypoints in their old format */
+/**
+* Fix savegames which stored waypoints in their old format
+*/
 void FixOldWaypoints()
 {
 	Waypoint *wp;
 	/* Convert the old 'town_or_string', to 'string' / 'town' / 'town_cn' */

branch	gamebalance
changeset 9908	0fa543611bbe
parent 9903	dc85aaa556ae
child 9913	e79cd19772dd