src/ai/api/ai_engine.hpp
branchnoai
changeset 9842 ef007135fa47
parent 9836 54afebfded49
child 10187 d5a6eba5af45
equal deleted inserted replaced
9841:f931a10242c9 9842:ef007135fa47
    86 	 */
    86 	 */
    87 	static uint32 GetPrice(EngineID engine_id);
    87 	static uint32 GetPrice(EngineID engine_id);
    88 
    88 
    89 	/**
    89 	/**
    90 	 * Get the maximum age of a brand new engine.
    90 	 * Get the maximum age of a brand new engine.
    91 	 * @note age is in days; divide by 366 to get per year.
       
    92 	 * @param engine_id The engine to get the maximum age of.
    91 	 * @param engine_id The engine to get the maximum age of.
    93 	 * @pre IsValidEngine(engine_id).
    92 	 * @pre IsValidEngine(engine_id).
    94 	 * @returns The maximum age of a new engine in days.
    93 	 * @returns The maximum age of a new engine in days.
       
    94 	 * @note Age is in days; divide by 366 to get per year.
    95 	 */
    95 	 */
    96 	static uint32 GetMaxAge(EngineID engine_id);
    96 	static uint32 GetMaxAge(EngineID engine_id);
    97 
    97 
    98 	/**
    98 	/**
    99 	 * Get the running cost of an engine.
    99 	 * Get the running cost of an engine.
   100 	 * @note cost is per year; divide by 364 to get per day.
       
   101 	 * @param engine_id The engine to get the running cost of.
   100 	 * @param engine_id The engine to get the running cost of.
   102 	 * @pre IsValidEngine(engine_id).
   101 	 * @pre IsValidEngine(engine_id).
   103 	 * @return The running cost of a vehicle per year.
   102 	 * @return The running cost of a vehicle per year.
       
   103 	 * @note Cost is per year; divide by 364 to get per day.
   104 	 */
   104 	 */
   105 	static Money GetRunningCost(EngineID engine_id);
   105 	static Money GetRunningCost(EngineID engine_id);
   106 
   106 
   107 	/**
   107 	/**
   108 	 * Get the type of an engine.
   108 	 * Get the type of an engine.