(svn r15541) -Revert (r15399): 'v->cargo_type' is also used in other places, which cannot accept CT_INVALID.

-Codechange: Add Engine::GetDefaultCargoType() and Engine::CanCarryCargo() and use them.
-Fix [FS#2617]: When articulated parts have no available default cargo, use the cargo type of the first part for livery selection.
-Change: To decide whether a vehicle is refittable do not test its current capacity for being zero, but always use the 'capacity property'.
  Note: The property is used unmodifed without calling CB 15/36. By setting it to a non-zero value and returning zero in the callback vehicles can be refitted to/from zero capacity for e.g. livery effects.
  Note: It is intentional that you cannot control refittability by CB 36.
This commit is contained in:
frosch
2009-02-21 12:52:41 +00:00
parent 9eb880ab43
commit abe4692da2
15 changed files with 171 additions and 163 deletions

View File

@@ -113,6 +113,66 @@ Engine::~Engine()
free(this->name);
}
/**
* Determines the default cargo type of an engine.
*
* Usually a valid cargo is returned, even though the vehicle has zero capacity, and can therefore not carry anything. But the cargotype is still used
* for livery selection etc..
*
* Vehicles with CT_INVALID as default cargo are usally not available, but it can appear as default cargo of articulated parts.
*
* @return The default cargo type.
* @see CanCarryCargo
*/
CargoID Engine::GetDefaultCargoType() const
{
switch (this->type) {
case VEH_TRAIN:
return this->u.rail.cargo_type;
case VEH_ROAD:
return this->u.road.cargo_type;
case VEH_SHIP:
return this->u.ship.cargo_type;
case VEH_AIRCRAFT:
return FindFirstRefittableCargo(this->index);
default: NOT_REACHED();
}
}
/**
* Determines whether an engine can carry something.
* A vehicle cannot carry anything if its capacity is zero, or none of the possible cargos is available in the climate.
* @return true if the vehicle can carry something.
*/
bool Engine::CanCarryCargo() const
{
/* For engines that can appear in a consist (i.e. rail vehicles and (articulated) road vehicles), a capacity
* of zero is a special case, to define the vehicle to not carry anything. The default cargotype is still used
* for livery selection etc.
* Note: Only the property is tested. A capacity callback returning 0 does not have the same effect.
*/
switch (this->type) {
case VEH_TRAIN:
if (this->u.rail.capacity == 0) return false;
break;
case VEH_ROAD:
if (this->u.road.capacity == 0) return false;
break;
case VEH_SHIP:
case VEH_AIRCRAFT:
break;
default: NOT_REACHED();
}
return this->GetDefaultCargoType() != CT_INVALID;
}
Money Engine::GetRunningCost() const
{
switch (this->type) {
@@ -668,6 +728,8 @@ bool IsEngineRefittable(EngineID engine)
if (e->type == VEH_SHIP && !e->u.ship.refittable) return false;
if (!e->CanCarryCargo()) return false;
const EngineInfo *ei = &e->info;
if (ei->refit_mask == 0) return false;
@@ -676,35 +738,6 @@ bool IsEngineRefittable(EngineID engine)
if (HasBit(ei->callbackmask, CBM_VEHICLE_CARGO_SUFFIX)) return true;
/* Is there any cargo except the default cargo? */
CargoID default_cargo = GetEngineCargoType(engine);
CargoID default_cargo = e->GetDefaultCargoType();
return default_cargo != CT_INVALID && ei->refit_mask != 1U << default_cargo;
}
/** Get the default cargo type for a certain engine type
* @param engine The ID to get the cargo for
* @return The cargo type. CT_INVALID means no cargo capacity
*/
CargoID GetEngineCargoType(EngineID engine)
{
assert(IsEngineIndex(engine));
switch (GetEngine(engine)->type) {
case VEH_TRAIN:
if (RailVehInfo(engine)->capacity == 0) return CT_INVALID;
return RailVehInfo(engine)->cargo_type;
case VEH_ROAD:
if (RoadVehInfo(engine)->capacity == 0) return CT_INVALID;
return RoadVehInfo(engine)->cargo_type;
case VEH_SHIP:
if (ShipVehInfo(engine)->capacity == 0) return CT_INVALID;
return ShipVehInfo(engine)->cargo_type;
case VEH_AIRCRAFT:
/* all aircraft starts as passenger planes with cargo capacity */
return CT_PASSENGERS;
default: NOT_REACHED(); return CT_INVALID;
}
}