OpenTTD

https://docs.openttd.org
Admin
OpenTTD is an open-source simulation game inspired by Transport Tycoon Deluxe where players build...
Tokens:6,833,682
Snippets:92,351
Trust Score:9.9
Update:1 week ago
Show doc for...
Tokens:
Raw
### Start

Source: https://docs.openttd.org/source/d6/d24/classMusicDriver__Allegro

Starts the Allegro music driver with the given parameters.

```APIDOC
## Start

### Description
Start this driver.

### Method
Start

### Signature
`std::optional<std::string_view> Start(const StringList &param) override`

### Parameters
- **param** (StringList) - Required - List of parameters for the driver.

### Returns
- **std::optional<std::string_view>** - An error message if startup failed, or std::nullopt on success.
```

--------------------------------

### Start

Source: https://docs.openttd.org/source/d8/d7e/classSoundDriver__Allegro

Starts the sound driver with the given parameters.

```APIDOC
## Start

### Description
Start this driver.

### Method
Start

### Signature
`std::optional<std::string_view> Start(const StringList &param) override`

### Parameters
- **param** (const StringList&) - Required - List of parameters for the driver.

### Returns
- **std::optional<std::string_view>** - An optional string view containing an error message if startup fails, or empty if successful.

```

--------------------------------

### Start(const StringList &param)

Source: https://docs.openttd.org/source/db/de3/classMusicDriver__DMusic

Starts the music driver with the given parameters.

```APIDOC
## Start(const StringList &param)

### Description
Starts the music driver with the given parameters.

### Method
Start

### Signature
`std::optional<std::string_view> Start(const StringList &param) override`

### Parameters
- **param** (StringList) - Required - List of parameters for the driver.

### Returns
- `std::optional<std::string_view>` - An error message if startup fails, or `std::nullopt` on success.

```

--------------------------------

### Start

Source: https://docs.openttd.org/source/d9/dcb/classVideoDriver__SDL__Default

Starts the video driver with the given parameters.

```APIDOC
## Start

### Description
Start this driver.

### Method
Start

### Signature
`std::optional<std::string_view> Start(const StringList &param) override`

### Parameters
- **param** (const StringList&) - Required - List of parameters for the driver.

### Returns
- **std::optional<std::string_view>** - An error message if the driver failed to start, or std::nullopt on success.
```

--------------------------------

### Start

Source: https://docs.openttd.org/source/d6/de2/classMusicDriver__FluidSynth

Starts the FluidSynth music driver.

```APIDOC
## Start

### Description
Start this driver.

### Method
Start

### Signature
`std::optional<std::string_view> Start(const StringList &param) override`

### Parameters
- **param** (StringList) - Required - List of parameters for starting the driver.

### Returns
- **std::optional<std::string_view>** - An optional string view, possibly containing an error message if startup fails.
```

--------------------------------

### Start

Source: https://docs.openttd.org/source/da/d06/classMusicDriver__Cocoa

Starts the driver with the given parameters.

```APIDOC
## Start

### Description
Starts this driver.

### Method
Start

### Signature
`std::optional<std::string_view> MusicDriver_Cocoa::Start(const StringList &parm)`

### Parameters
- **parm** (const StringList&) - Required - Parameters passed to the driver.

### Returns
`std::nullopt` if everything went okay, otherwise an error message.

### Implements
Driver::Start
```

--------------------------------

### Start

Source: https://docs.openttd.org/source/d7/d05/classVideoDriver__CocoaQuartz

Starts the Cocoa Quartz video driver.

```APIDOC
## Start

### Description
Starts the Cocoa Quartz video driver.

### Method
Start

### Parameters
- **param** (StringList) - Required - List of parameters for the driver.

### Returns
- **std::optional<std::string_view>** - Optional error message if startup fails.
```

--------------------------------

### Start

Source: https://docs.openttd.org/source/d6/d38/classMusicDriver__BeMidi

Starts the music driver. This method is called to initialize the driver.

```APIDOC
## Start

### Description
Start this driver.

### Method
Start

### Parameters
- param (const StringList&) - Required - List of parameters for the driver.

### Returns
std::optional<std::string_view> - Optional error message if startup fails.
```

--------------------------------

### GetStartPos

Source: https://docs.openttd.org/source/d1/dec/classSpriteFile

Gets the start position of the file.

```APIDOC
## GetStartPos

### Description
Returns the start position of the file.

### Signature
size_t GetStartPos() const

### Returns
- **size_t** - The start position.

```

--------------------------------

### SetupColoursAndInitialWindow

Source: https://docs.openttd.org/source/df/d20/window__func_8h

Initializes the default colours and loads the main windows.

```APIDOC
## SetupColoursAndInitialWindow

### Description
Initializes the default colours (remaps and the likes) and loads the main windows.

### Function Signature
`void SetupColoursAndInitialWindow()`
```

--------------------------------

### GSBridge::GetOtherBridgeEnd

Source: https://docs.openttd.org/gs-api/classGSBridge

Get the tile that is on the other end of a bridge starting at tile.

```APIDOC
## GSBridge::GetOtherBridgeEnd

### Description
Get the tile that is on the other end of a bridge starting at tile.

### Method
Static function

### Parameters
- **tile** (TileIndex) - The tile at one end of the bridge.

### Return Value
- **TileIndex** - The tile at the other end of the bridge.
```

--------------------------------

### AIBridge::GetOtherBridgeEnd

Source: https://docs.openttd.org/ai-api/classAIBridge

Get the tile that is on the other end of a bridge starting at tile.

```APIDOC
## GetOtherBridgeEnd

### Description
Get the tile that is on the other end of a bridge starting at tile.

### Method
static TileIndex GetOtherBridgeEnd(TileIndex tile)

### Parameters
- **tile** (TileIndex) - The tile at one end of the bridge.

### Returns
- **TileIndex** - The tile at the other end of the bridge.
```

--------------------------------

### Start

Source: https://docs.openttd.org/source/d1/dce/classSoundDriver__XAudio2

Initialises the XAudio2 driver. Takes a list of driver parameters and returns an error message if unsuccessful, or std::nullopt otherwise.

```APIDOC
## Start

### Description
Initialises the XAudio2 driver.

### Method
Start

### Signature
std::optional<std::string_view> Start(const StringList &param) override

### Parameters
- **param** (StringList) - Required - Driver parameters.

### Returns
An error message if unsuccessful, or std::nullopt otherwise.

### Implements
Driver
```

--------------------------------

### GetOtherTunnelEnd

Source: https://docs.openttd.org/gs-api/classGSTunnel

Gets the tile that exits on the other end of a (would be) tunnel starting at the given tile. Returns GSMap::TILE_INVALID if there is no simple inclined slope at the start tile or no other end is found.

```APIDOC
## GetOtherTunnelEnd

### Description
Gets the tile that exits on the other end of a (would be) tunnel starting at the given tile. Returns GSMap::TILE_INVALID if there is no simple inclined slope at the start tile or no other end is found.

### Method
static

### Signature
`static TileIndex GSTunnel::GetOtherTunnelEnd(TileIndex tile)`

### Parameters
- **tile** (TileIndex) - Required - The tile that is an entrance to a tunnel or the tile where you may want to build a tunnel.

### Precondition
- GSMap::IsValidTile(tile)

### Returns
- **TileIndex** - The tile that is the other end of the (would be) tunnel, or GSMap::TILE_INVALID if no other end was found (can't build tunnel).

### Note
Even if this function returns a valid tile, that is no guarantee that building a tunnel will succeed. Use BuildTunnel in GSTestMode to check whether a tunnel can actually be built.
```

--------------------------------

### Start(const StringList &param)

Source: https://docs.openttd.org/source/d2/d35/classSoundDriver__Cocoa

Starts the sound driver with the given parameters. Returns std::nullopt on success or an error message on failure.

```APIDOC
## Start(const StringList &param)

### Description
Starts this driver. This method is called to initialize the sound driver with the provided parameters.

### Method
Start

### Parameters
- **param** (const StringList&) - Parameters passed to the driver.

### Returns
- **std::optional<std::string_view>** - std::nullopt if everything went okay, otherwise an error message.

### Implementation
Implements Driver.
```

--------------------------------

### GetCharPosInString

Source: https://docs.openttd.org/source/dc/d5d/gfx__layout_8cpp

Gets the leading corner of a character in a single-line string relative to the start of the string.

```APIDOC
## GetCharPosInString

### Description
Gets the leading corner of a character in a single-line string relative to the start of the string.

### Function Signature
```cpp
ParagraphLayouter::Position GetCharPosInString(std::string_view str, size_t pos, FontSize start_fontsize)
```

### Parameters
- **str** (std::string_view) - Required - String containing the character.
- **pos** (size_t) - Required - Index to the character in the string.
- **start_fontsize** (FontSize) - Required - Font size to start the text with.

### Returns
- **ParagraphLayouter::Position** - Upper left corner of the glyph associated with the character.
```

--------------------------------

### GSTunnel::GetOtherTunnelEnd

Source: https://docs.openttd.org/gs-api/classGSTunnel

Gets the tile that exits on the other end of a (would be) tunnel starting at the given tile.

```APIDOC
## GSTunnel::GetOtherTunnelEnd

### Description
Get the tile that exits on the other end of a (would be) tunnel starting at tile.

### Method
static TileIndex GetOtherTunnelEnd(TileIndex tile)

### Parameters
- **tile** (TileIndex) - Required - The tile to check.

### Returns
- **TileIndex** - The tile at the other end of the tunnel.
```

--------------------------------

### AITunnel::GetOtherTunnelEnd

Source: https://docs.openttd.org/ai-api/classAITunnel

Gets the tile that exits on the other end of a (would be) tunnel starting at the given tile.

```APIDOC
## GetOtherTunnelEnd

### Description
Get the tile that exits on the other end of a (would be) tunnel starting at tile.

### Method
static TileIndex GetOtherTunnelEnd(TileIndex tile)

### Parameters
- **tile** (TileIndex) - Required - The tile to start from.

### Returns
- **TileIndex** - The tile at the other end of the tunnel.
```

--------------------------------

### Start

Source: https://docs.openttd.org/source/d8/d1d/classSoundDriver__SDL

Starts the SDL sound driver with the given parameters. Returns std::nullopt on success or an error message on failure.

```APIDOC
## Start

### Description
Starts the SDL sound driver with the given parameters.

### Method
Start

### Signature
`std::optional<std::string_view> Start(const StringList &param) override`

### Parameters
- **param** (const StringList&) - Parameters passed to the driver.

### Returns
- `std::nullopt` if everything went okay, otherwise an error message.

### Notes
- Implements Driver::Start.
```

--------------------------------

### AITown::GetAllowedNoise

Source: https://docs.openttd.org/ai-api/classAITown

Get the maximum level of noise that still can be added by airports before the town start to refuse building a new airport.

```APIDOC
## GetAllowedNoise

### Description
Get the maximum level of noise that still can be added by airports before the town start to refuse building a new airport. This is a static method of the AITown class. It returns the allowed noise level as an integer.

### Method
static int GetAllowedNoise(TownID town_id)

### Parameters
- **town_id** (TownID) - The town ID.

### Return Value
- **int** - The maximum allowed noise level.

```

--------------------------------

### AITunnel::GetOtherTunnelEnd

Source: https://docs.openttd.org/ai-api/classAITunnel

Gets the tile that exits on the other end of a (would be) tunnel starting at the given tile. Returns AIMap::TILE_INVALID if no other end is found.

```APIDOC
## AITunnel::GetOtherTunnelEnd

### Description
Gets the tile that exits on the other end of a (would be) tunnel starting at the given tile. If there is no 'simple' inclined slope at the start tile, this function will return AIMap::TILE_INVALID.

### Method
static TileIndex GetOtherTunnelEnd(TileIndex tile)

### Parameters
- **tile** (TileIndex) - Required - The tile that is an entrance to a tunnel or the tile where you may want to build a tunnel.

### Precondition
AIMap::IsValidTile(tile)

### Returns
- **TileIndex** - The tile that is the other end of the (would be) tunnel, or AIMap::TILE_INVALID if no other end was found (can't build tunnel).

### Note
Even if this function returns a valid tile, that is no guarantee that building a tunnel will succeed. Use BuildTunnel in AITestMode to check whether a tunnel can actually be built.
```

--------------------------------

### Start

Source: https://docs.openttd.org/source/d1/d97/structNewGRFProfiler

Starts the profiling session.

```APIDOC
## void Start()

### Description
Starts the profiling session.

### Returns
void
```
Tokens:
Raw