summaryrefslogtreecommitdiff
path: root/src/engine_base.h
diff options
context:
space:
mode:
Diffstat (limited to 'src/engine_base.h')
-rw-r--r--src/engine_base.h18
1 files changed, 17 insertions, 1 deletions
diff --git a/src/engine_base.h b/src/engine_base.h
index 9a6930868..1c798ccf1 100644
--- a/src/engine_base.h
+++ b/src/engine_base.h
@@ -86,7 +86,23 @@ struct Engine : EnginePool::PoolItem<&_engine_pool> {
uint DetermineCapacity(const Vehicle *v, uint16 *mail_capacity = NULL) const;
bool CanCarryCargo() const;
- uint GetDisplayDefaultCapacity(uint16 *mail_capacity = NULL) const;
+
+ /**
+ * Determines the default cargo capacity of an engine for display purposes.
+ *
+ * For planes carrying both passenger and mail this is the passenger capacity.
+ * For multiheaded engines this is the capacity of both heads.
+ * For articulated engines use GetCapacityOfArticulatedParts
+ *
+ * @param mail_capacity returns secondary cargo (mail) capacity of aircraft
+ * @return The default capacity
+ * @see GetDefaultCargoType
+ */
+ uint GetDisplayDefaultCapacity(uint16 *mail_capacity = NULL) const
+ {
+ return this->DetermineCapacity(NULL, mail_capacity);
+ }
+
Money GetRunningCost() const;
Money GetCost() const;
uint GetDisplayMaxSpeed() const;