openttd-ottdgrfs: comparison src/rail

equal deleted inserted replaced

-:0fa543611bbe
+:dce9a6923bb7
 /* Validate functions for rail building */
 static inline bool ValParamTrackOrientation(Track track) {return IsValidTrack(track);}
 /** Build a single piece of rail
 * @param tile tile  to build on
+* @param flags operation to perform
 * @param p1 railtype of being built piece (normal, mono, maglev)
 * @param p2 rail track to build
 */
 int32 CmdBuildSingleRail(TileIndex tile, uint32 flags, uint32 p1, uint32 p2)
 {
 	return cost;
 }
 /** Remove a single piece of track
 * @param tile tile to remove track from
+* @param flags operation to perform
 * @param p1 unused
 * @param p2 rail orientation
 */
 int32 CmdRemoveSingleRail(TileIndex tile, uint32 flags, uint32 p1, uint32 p2)
 {
 	return 0;
 }
 /** Build a stretch of railroad tracks.
 * @param tile start tile of drag
+* @param flags operation to perform
 * @param p1 end tile of drag
 * @param p2 various bitstuffed elements
 * - p2 = (bit 0-3) - railroad type normal/maglev (0 = normal, 1 = mono, 2 = maglev)
 * - p2 = (bit 4-6) - track-orientation, valid values: 0-5 (Track enum)
 * - p2 = (bit 7)   - 0 = build, 1 = remove tracks
 	return (total_cost == 0) ? CMD_ERROR : total_cost;
 }
 /** Build rail on a stretch of track.
 * Stub for the unified rail builder/remover
+* @param tile start tile of drag
+* @param flags operation to perform
+* @param p1 end tile of drag
+* @param p2 various bitstuffed elements
+* - p2 = (bit 0-3) - railroad type normal/maglev (0 = normal, 1 = mono, 2 = maglev)
+* - p2 = (bit 4-6) - track-orientation, valid values: 0-5 (Track enum)
+* - p2 = (bit 7)   - 0 = build, 1 = remove tracks
 * @see CmdRailTrackHelper
 */
 int32 CmdBuildRailroadTrack(TileIndex tile, uint32 flags, uint32 p1, uint32 p2)
 {
 	return CmdRailTrackHelper(tile, flags, p1, CLRBIT(p2, 7));
 }
 /** Build rail on a stretch of track.
 * Stub for the unified rail builder/remover
+* @param tile start tile of drag
+* @param flags operation to perform
+* @param p1 end tile of drag
+* @param p2 various bitstuffed elements
+* - p2 = (bit 0-3) - railroad type normal/maglev (0 = normal, 1 = mono, 2 = maglev)
+* - p2 = (bit 4-6) - track-orientation, valid values: 0-5 (Track enum)
+* - p2 = (bit 7)   - 0 = build, 1 = remove tracks
 * @see CmdRailTrackHelper
 */
 int32 CmdRemoveRailroadTrack(TileIndex tile, uint32 flags, uint32 p1, uint32 p2)
 {
 	return CmdRailTrackHelper(tile, flags, p1, SETBIT(p2, 7));
 }
 /** Build a train depot
 * @param tile position of the train depot
+* @param flags operation to perform
 * @param p1 rail type
 * @param p2 bit 0..1 entrance direction (DiagDirection)
 *
 * @todo When checking for the tile slope,
 * distingush between "Flat land required" and "land sloped in wrong direction"
 /** Build signals, alternate between double/single, signal/semaphore,
 * pre/exit/combo-signals, and what-else not. If the rail piece does not
 * have any signals, bit 4 (cycle signal-type) is ignored
 * @param tile tile where to build the signals
+* @param flags operation to perform
 * @param p1 various bitstuffed elements
 * - p1 = (bit 0-2) - track-orientation, valid values: 0-5 (Track enum)
 * - p1 = (bit 3)   - 1 = override signal/semaphore, or pre/exit/combo signal (CTRL-toggle)
 * - p1 = (bit 4)   - 0 = signals, 1 = semaphores
 * @param p2 used for CmdBuildManySignals() to copy direction of first signal
 	return cost;
 }
 /** Build many signals by dragging; AutoSignals
 * @param tile start tile of drag
+* @param flags operation to perform
 * @param p1  end tile of drag
 * @param p2 various bitstuffed elements
 * - p2 = (bit  0- 2) - track-orientation, valid values: 0-5 (Track enum)
 * - p2 = (bit  3)    - 1 = override signal/semaphore, or pre/exit/combo signal (CTRL-toggle)
 * - p2 = (bit  4)    - 0 = signals, 1 = semaphores
 	return error ? CMD_ERROR : total_cost;
 }
 /** Build signals on a stretch of track.
 * Stub for the unified signal builder/remover
+* @param tile start tile of drag
+* @param flags operation to perform
+* @param p1  end tile of drag
+* @param p2 various bitstuffed elements
+* - p2 = (bit  0- 2) - track-orientation, valid values: 0-5 (Track enum)
+* - p2 = (bit  3)    - 1 = override signal/semaphore, or pre/exit/combo signal (CTRL-toggle)
+* - p2 = (bit  4)    - 0 = signals, 1 = semaphores
+* - p2 = (bit  5)    - 0 = build, 1 = remove signals
+* - p2 = (bit 24-31) - user defined signals_density
 * @see CmdSignalTrackHelper
 */
 int32 CmdBuildSignalTrack(TileIndex tile, uint32 flags, uint32 p1, uint32 p2)
 {
 	return CmdSignalTrackHelper(tile, flags, p1, p2);
 }
 /** Remove signals
 * @param tile coordinates where signal is being deleted from
-* @param various bitstuffed elements, only track information is used
+* @param flags operation to perform
-* - p1 = (bit  0- 2) - track-orientation, valid values: 0-5 (Track enum)
+* @param p1 various bitstuffed elements, only track information is used
-* - p1 = (bit  3)    - override signal/semaphore, or pre/exit/combo signal (CTRL-toggle)
+*           - (bit  0- 2) - track-orientation, valid values: 0-5 (Track enum)
-* - p1 = (bit  4)    - 0 = signals, 1 = semaphores
+*           - (bit  3)    - override signal/semaphore, or pre/exit/combo signal (CTRL-toggle)
+*           - (bit  4)    - 0 = signals, 1 = semaphores
+* @param p2 unused
 */
 int32 CmdRemoveSingleSignal(TileIndex tile, uint32 flags, uint32 p1, uint32 p2)
 {
 	Track track = (Track)GB(p1, 0, 3);
 	return _eco->GetPrice(CEconomy::REMOVE_SIGNALS);
 }
 /** Remove signals on a stretch of track.
 * Stub for the unified signal builder/remover
+* @param tile start tile of drag
+* @param flags operation to perform
+* @param p1  end tile of drag
+* @param p2 various bitstuffed elements
+* - p2 = (bit  0- 2) - track-orientation, valid values: 0-5 (Track enum)
+* - p2 = (bit  3)    - 1 = override signal/semaphore, or pre/exit/combo signal (CTRL-toggle)
+* - p2 = (bit  4)    - 0 = signals, 1 = semaphores
+* - p2 = (bit  5)    - 0 = build, 1 = remove signals
+* - p2 = (bit 24-31) - user defined signals_density
 * @see CmdSignalTrackHelper
 */
 int32 CmdRemoveSignalTrack(TileIndex tile, uint32 flags, uint32 p1, uint32 p2)
 {
 	return CmdSignalTrackHelper(tile, flags, p1, SETBIT(p2, 5)); // bit 5 is remove bit
 extern int32 DoConvertTunnelBridgeRail(TileIndex tile, RailType totype, bool exec);
 /** Convert one rail type to the other. You can convert normal rail to
 * monorail/maglev easily or vice-versa.
 * @param tile end tile of rail conversion drag
+* @param flags operation to perform
 * @param p1 start tile of drag
 * @param p2 new railtype to convert to
 */
 int32 CmdConvertRail(TileIndex tile, uint32 flags, uint32 p1, uint32 p2)
 {
 /**
 * Draw ground sprite and track bits
 * @param ti TileInfo
 * @param track TrackBits to draw
-* @param earth Draw as earth
-* @param snow Draw as snow
-* @param flat Always draw foundation
 */
 static void DrawTrackBits(TileInfo* ti, TrackBits track)
 {
 	const RailtypeInfo *rti = GetRailTypeInfo(GetRailType(ti->tile));
 	SpriteID image;

branch	gamebalance
changeset 9909	dce9a6923bb7
parent 9908	0fa543611bbe
child 9911	0b8b245a2391