From f64ea65d03e89587c904f4bae067aeba50a672de Mon Sep 17 00:00:00 2001 From: Duncan Date: Sun, 29 Mar 2020 09:23:24 +0100 Subject: [PATCH] Rename SPRITE_LIST_TRAIN_HEAD to reduce car head confusion (#11105) A single car on a coaster can comprise of multiple vehicles. One of those vehicles will be the car head vehicle. The train can comprise of multiple cars. Therefore not all vehicle->IsHead 's will be in SPRITE_LIST_TRAIN_HEAD. This rename makes that slightly more clear --- src/openrct2-ui/windows/Map.cpp | 2 +- src/openrct2/rct1/S4Importer.cpp | 2 +- src/openrct2/ride/CableLift.cpp | 2 +- src/openrct2/ride/Ride.cpp | 2 +- src/openrct2/ride/Vehicle.cpp | 4 ++-- src/openrct2/world/Sprite.cpp | 2 +- src/openrct2/world/Sprite.h | 2 +- 7 files changed, 8 insertions(+), 8 deletions(-) diff --git a/src/openrct2-ui/windows/Map.cpp b/src/openrct2-ui/windows/Map.cpp index 07e9511113..6d81b3fba3 100644 --- a/src/openrct2-ui/windows/Map.cpp +++ b/src/openrct2-ui/windows/Map.cpp @@ -1102,7 +1102,7 @@ static void window_map_paint_train_overlay(rct_drawpixelinfo* dpi) Vehicle *train, *vehicle; uint16_t train_index, vehicle_index; - for (train_index = gSpriteListHead[SPRITE_LIST_VEHICLE_HEAD]; train_index != SPRITE_INDEX_NULL; train_index = train->next) + for (train_index = gSpriteListHead[SPRITE_LIST_TRAIN_HEAD]; train_index != SPRITE_INDEX_NULL; train_index = train->next) { train = GET_VEHICLE(train_index); for (vehicle_index = train_index; vehicle_index != SPRITE_INDEX_NULL; vehicle_index = vehicle->next_vehicle_on_train) diff --git a/src/openrct2/rct1/S4Importer.cpp b/src/openrct2/rct1/S4Importer.cpp index 8b437415da..66c2126407 100644 --- a/src/openrct2/rct1/S4Importer.cpp +++ b/src/openrct2/rct1/S4Importer.cpp @@ -1123,7 +1123,7 @@ private: // If vehicle is the first car on a train add to train list if (vehicle->IsHead()) { - move_sprite_to_list(vehicle, SPRITE_LIST_VEHICLE_HEAD); + move_sprite_to_list(vehicle, SPRITE_LIST_TRAIN_HEAD); } } } diff --git a/src/openrct2/ride/CableLift.cpp b/src/openrct2/ride/CableLift.cpp index d5c8e0f9ca..24bb4aa820 100644 --- a/src/openrct2/ride/CableLift.cpp +++ b/src/openrct2/ride/CableLift.cpp @@ -35,7 +35,7 @@ Vehicle* cable_lift_segment_create( current->ride_subtype = RIDE_ENTRY_INDEX_NULL; if (head) { - move_sprite_to_list(current, SPRITE_LIST_VEHICLE_HEAD); + move_sprite_to_list(current, SPRITE_LIST_TRAIN_HEAD); ride.cable_lift = current->sprite_index; } current->type = head ? VEHICLE_TYPE_HEAD : VEHICLE_TYPE_TAIL; diff --git a/src/openrct2/ride/Ride.cpp b/src/openrct2/ride/Ride.cpp index 0a17efb30a..f2b79fb7f7 100644 --- a/src/openrct2/ride/Ride.cpp +++ b/src/openrct2/ride/Ride.cpp @@ -4561,7 +4561,7 @@ static void vehicle_create_trains(ride_id_t rideIndex, int32_t x, int32_t y, int lastTrain = train; // Add train to ride vehicle list - move_sprite_to_list(train.head, SPRITE_LIST_VEHICLE_HEAD); + move_sprite_to_list(train.head, SPRITE_LIST_TRAIN_HEAD); for (int32_t i = 0; i <= MAX_VEHICLES_PER_RIDE; i++) { if (ride->vehicles[i] == SPRITE_INDEX_NULL) diff --git a/src/openrct2/ride/Vehicle.cpp b/src/openrct2/ride/Vehicle.cpp index c78ce7df8f..cd42972fd1 100644 --- a/src/openrct2/ride/Vehicle.cpp +++ b/src/openrct2/ride/Vehicle.cpp @@ -1284,7 +1284,7 @@ void vehicle_sounds_update() vehicle_sounds_update_window_setup(); - for (uint16_t i = gSpriteListHead[SPRITE_LIST_VEHICLE_HEAD]; i != SPRITE_INDEX_NULL; i = get_sprite(i)->vehicle.next) + for (uint16_t i = gSpriteListHead[SPRITE_LIST_TRAIN_HEAD]; i != SPRITE_INDEX_NULL; i = get_sprite(i)->vehicle.next) { get_sprite(i)->vehicle.UpdateSoundParams(vehicleSoundParamsList); } @@ -1365,7 +1365,7 @@ void vehicle_update_all() if ((gScreenFlags & SCREEN_FLAGS_TRACK_DESIGNER) && gS6Info.editor_step != EDITOR_STEP_ROLLERCOASTER_DESIGNER) return; - sprite_index = gSpriteListHead[SPRITE_LIST_VEHICLE_HEAD]; + sprite_index = gSpriteListHead[SPRITE_LIST_TRAIN_HEAD]; while (sprite_index != SPRITE_INDEX_NULL) { vehicle = GET_VEHICLE(sprite_index); diff --git a/src/openrct2/world/Sprite.cpp b/src/openrct2/world/Sprite.cpp index a74cb004f6..13e0ad835b 100644 --- a/src/openrct2/world/Sprite.cpp +++ b/src/openrct2/world/Sprite.cpp @@ -855,7 +855,7 @@ static bool sprite_should_tween(rct_sprite* sprite) switch (sprite->generic.linked_list_index) { case SPRITE_LIST_PEEP: - case SPRITE_LIST_VEHICLE_HEAD: + case SPRITE_LIST_TRAIN_HEAD: case SPRITE_LIST_VEHICLE: return true; } diff --git a/src/openrct2/world/Sprite.h b/src/openrct2/world/Sprite.h index 09a7770000..62e5d84803 100644 --- a/src/openrct2/world/Sprite.h +++ b/src/openrct2/world/Sprite.h @@ -31,7 +31,7 @@ enum SPRITE_IDENTIFIER enum SPRITE_LIST { SPRITE_LIST_FREE, - SPRITE_LIST_VEHICLE_HEAD, + SPRITE_LIST_TRAIN_HEAD, SPRITE_LIST_PEEP, SPRITE_LIST_MISC, SPRITE_LIST_LITTER,