OpenTTD Source 20241224-master-gf74b0cf984
rail_cmd.h
Go to the documentation of this file.
1/*
2 * This file is part of OpenTTD.
3 * 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.
4 * 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.
5 * 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/>.
6 */
7
10#ifndef RAIL_CMD_H
11#define RAIL_CMD_H
12
13#include "command_type.h"
14#include "track_type.h"
15#include "rail_type.h"
16#include "signal_type.h"
17
18CommandCost CmdBuildRailroadTrack(DoCommandFlag flags, TileIndex end_tile, TileIndex start_tile, RailType railtype, Track track, bool auto_remove_signals, bool fail_on_obstacle);
20CommandCost CmdBuildSingleRail(DoCommandFlag flags, TileIndex tile, RailType railtype, Track track, bool auto_remove_signals);
23CommandCost CmdBuildSingleSignal(DoCommandFlag flags, TileIndex tile, Track track, SignalType sigtype, SignalVariant sigvar, bool convert_signal, bool skip_existing_signals, bool ctrl_pressed, SignalType cycle_start, SignalType cycle_stop, uint8_t num_dir_cycle, uint8_t signals_copy);
25CommandCost CmdConvertRail(DoCommandFlag flags, TileIndex tile, TileIndex area_start, RailType totype, bool diagonal);
26CommandCost CmdBuildSignalTrack(DoCommandFlag flags, TileIndex tile, TileIndex end_tile, Track track, SignalType sigtype, SignalVariant sigvar, bool mode, bool autofill, bool minimise_gaps, uint8_t signal_density);
27CommandCost CmdRemoveSignalTrack(DoCommandFlag flags, TileIndex tile, TileIndex end_tile, Track track, bool autofill);
28
39
40CommandCallback CcPlaySound_CONSTRUCTION_RAIL;
41CommandCallback CcStation;
42CommandCallback CcBuildRailTunnel;
43void CcRailDepot(Commands cmd, const CommandCost &result, TileIndex tile, RailType rt, DiagDirection dir);
44
45#endif /* RAIL_CMD_H */
Common return value for all commands.
Types related to commands.
void CommandCallback(Commands cmd, const CommandCost &result, TileIndex tile)
Define a callback function for the client, after the command is finished.
@ CMDT_LANDSCAPE_CONSTRUCTION
Construction and destruction of objects on the map.
DoCommandFlag
List of flags for a command.
Commands
List of commands.
@ CMD_BUILD_TRAIN_DEPOT
build a train depot
@ CMD_REMOVE_SINGLE_RAIL
remove a single rail track
@ CMD_CONVERT_RAIL
convert a rail type
@ CMD_BUILD_SIGNAL_TRACK
add signals along a track (by dragging)
@ CMD_REMOVE_RAILROAD_TRACK
remove a rail track
@ CMD_BUILD_RAILROAD_TRACK
build a rail track
@ CMD_BUILD_SINGLE_SIGNAL
build a signal
@ CMD_REMOVE_SIGNAL_TRACK
remove signals along a track (by dragging)
@ CMD_BUILD_SINGLE_RAIL
build a single rail track
@ CMD_REMOVE_SINGLE_SIGNAL
remove a signal
@ CMD_AUTO
set the DC_AUTO flag on this command
@ CMD_NO_WATER
set the DC_NO_WATER flag on this command
DiagDirection
Enumeration for diagonal directions.
CommandCost CmdRemoveRailroadTrack(DoCommandFlag flags, TileIndex end_tile, TileIndex start_tile, Track track)
Build rail on a stretch of track.
Definition rail_cmd.cpp:947
CommandCost CmdRemoveSingleSignal(DoCommandFlag flags, TileIndex tile, Track track)
Remove signals.
CommandCost CmdBuildSingleSignal(DoCommandFlag flags, TileIndex tile, Track track, SignalType sigtype, SignalVariant sigvar, bool convert_signal, bool skip_existing_signals, bool ctrl_pressed, SignalType cycle_start, SignalType cycle_stop, uint8_t num_dir_cycle, uint8_t signals_copy)
Build signals, alternate between double/single, signal/semaphore, pre/exit/combo-signals,...
CommandCost CmdRemoveSignalTrack(DoCommandFlag flags, TileIndex tile, TileIndex end_tile, Track track, bool autofill)
Remove signals on a stretch of track.
CommandCost CmdBuildRailroadTrack(DoCommandFlag flags, TileIndex end_tile, TileIndex start_tile, RailType railtype, Track track, bool auto_remove_signals, bool fail_on_obstacle)
Build rail on a stretch of track.
Definition rail_cmd.cpp:932
CommandCost CmdConvertRail(DoCommandFlag flags, TileIndex tile, TileIndex area_start, RailType totype, bool diagonal)
Convert one rail type to the other.
CommandCost CmdBuildTrainDepot(DoCommandFlag flags, TileIndex tile, RailType railtype, DiagDirection dir)
Build a train depot.
Definition rail_cmd.cpp:963
CommandCost CmdBuildSignalTrack(DoCommandFlag flags, TileIndex tile, TileIndex end_tile, Track track, SignalType sigtype, SignalVariant sigvar, bool mode, bool autofill, bool minimise_gaps, uint8_t signal_density)
Build signals on a stretch of track.
CommandCost CmdBuildSingleRail(DoCommandFlag flags, TileIndex tile, RailType railtype, Track track, bool auto_remove_signals)
Build a single piece of rail.
Definition rail_cmd.cpp:426
CommandCost CmdRemoveSingleRail(DoCommandFlag flags, TileIndex tile, Track track)
Remove a single piece of track.
Definition rail_cmd.cpp:615
The different types of rail.
RailType
Enumeration for all possible railtypes.
Definition rail_type.h:27
Types and classes related to signals.
SignalType
Type of signal, i.e.
Definition signal_type.h:23
SignalVariant
Variant of the signal, i.e.
Definition signal_type.h:16
All types related to tracks.
Track
These are used to specify a single track.
Definition track_type.h:19