miguel.horta/openttd-cmclient
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Codechange: Standardise how AllocateSpecToStation/RoadStop are called. (#14525)

Browse Source 
Replace use of negative value with std::optional and update doxygen.
This commit is contained in:
Peter Nelson
2025-08-19 18:52:36 +01:00
committed by GitHub
parent 5eeede82c5
commit 1cb0cbcb6c
7 changed files with 39 additions and 32 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
src/newgrf_roadstop.cpp
View File

@@ -559,7 +559,14 @@ const RoadStopSpec *GetRoadStopSpec(TileIndex t)
return specindex < st->roadstop_speclist.size() ? st->roadstop_speclist[specindex].spec : nullptr;
}
int AllocateSpecToRoadStop(const RoadStopSpec *statspec, BaseStation *st, bool exec)
/**
* Allocate a RoadStopSpec to a Station. This is called once per build operation.
* @param statspec RoadStopSpec to allocate.
* @param st Station to allocate it to.
* @param exec Whether to actually allocate the spec.
* @return Index within the Station's road stop spec list, or std::nullopt if the allocation failed.
*/
std::optional<uint8_t> AllocateSpecToRoadStop(const RoadStopSpec *statspec, BaseStation *st, bool exec)
{
uint i;
@@ -577,7 +584,7 @@ int AllocateSpecToRoadStop(const RoadStopSpec *statspec, BaseStation *st, bool e
if (i == NUM_ROADSTOPSPECS_PER_STATION) {
/* Full, give up */
return -1;
return std::nullopt;
}
if (exec) {
@@ -592,6 +599,11 @@ int AllocateSpecToRoadStop(const RoadStopSpec *statspec, BaseStation *st, bool e
return i;
}
/**
* Deallocate a RoadStopSpec from a Station. Called when removing a single roadstop tile.
* @param st Station to work with.
* @param specindex Index of the custom roadstop within the Station's roadstop spec list.
*/
void DeallocateSpecFromRoadStop(BaseStation *st, uint8_t specindex)
{
/* specindex of 0 (default) is never freeable */