|
|
|
/* $Id$ */
|
|
|
|
|
|
|
|
/** @file order_base.h */
|
|
|
|
|
|
|
|
#ifndef ORDER_BASE_H
|
|
|
|
#define ORDER_BASE_H
|
|
|
|
|
|
|
|
#include "order_type.h"
|
|
|
|
#include "oldpool.h"
|
|
|
|
#include "core/bitmath_func.hpp"
|
|
|
|
#include "cargo_type.h"
|
|
|
|
#include "station_type.h"
|
|
|
|
#include "vehicle_type.h"
|
|
|
|
|
|
|
|
DECLARE_OLD_POOL(Order, Order, 6, 1000)
|
|
|
|
|
|
|
|
/* If you change this, keep in mind that it is saved on 3 places:
|
|
|
|
* - Load_ORDR, all the global orders
|
|
|
|
* - Vehicle -> current_order
|
|
|
|
* - REF_ORDER (all REFs are currently limited to 16 bits!!)
|
|
|
|
*/
|
|
|
|
struct Order : PoolItem<Order, OrderID, &_Order_pool> {
|
|
|
|
Order *next; ///< Pointer to next order. If NULL, end of list
|
|
|
|
|
|
|
|
OrderTypeByte type;
|
|
|
|
uint8 flags;
|
|
|
|
DestinationID dest; ///< The destionation of the order.
|
|
|
|
|
|
|
|
CargoID refit_cargo; // Refit CargoID
|
|
|
|
byte refit_subtype; // Refit subtype
|
|
|
|
|
|
|
|
uint16 wait_time; ///< How long in ticks to wait at the destination.
|
|
|
|
uint16 travel_time; ///< How long in ticks the journey to this destination should take.
|
|
|
|
|
|
|
|
Order() : refit_cargo(CT_NO_REFIT) {}
|
|
|
|
~Order() { this->type = OT_NOTHING; }
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Check if a Order really exists.
|
|
|
|
*/
|
|
|
|
inline bool IsValid() const { return this->type != OT_NOTHING; }
|
|
|
|
|
|
|
|
/**
|
|
|
|
* 'Free' the order
|
|
|
|
* @note ONLY use on "current_order" vehicle orders!
|
|
|
|
*/
|
|
|
|
void Free();
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Free a complete order chain.
|
|
|
|
* @note do not use on "current_order" vehicle orders!
|
|
|
|
*/
|
|
|
|
void FreeChain();
|
|
|
|
|
|
|
|
bool ShouldStopAtStation(const Vehicle *v, StationID station) const;
|
|
|
|
};
|
|
|
|
|
|
|
|
static inline VehicleOrderID GetMaxOrderIndex()
|
|
|
|
{
|
|
|
|
/* TODO - This isn't the real content of the function, but
|
|
|
|
* with the new pool-system this will be replaced with one that
|
|
|
|
* _really_ returns the highest index. Now it just returns
|
|
|
|
* the next safe value we are sure about everything is below.
|
|
|
|
*/
|
|
|
|
return GetOrderPoolSize() - 1;
|
|
|
|
}
|
|
|
|
|
|
|
|
static inline VehicleOrderID GetNumOrders()
|
|
|
|
{
|
|
|
|
return GetOrderPoolSize();
|
|
|
|
}
|
|
|
|
|
|
|
|
#define FOR_ALL_ORDERS_FROM(order, start) for (order = GetOrder(start); order != NULL; order = (order->index + 1U < GetOrderPoolSize()) ? GetOrder(order->index + 1U) : NULL) if (order->IsValid())
|
|
|
|
#define FOR_ALL_ORDERS(order) FOR_ALL_ORDERS_FROM(order, 0)
|
|
|
|
|
|
|
|
|
|
|
|
#define FOR_VEHICLE_ORDERS(v, order) for (order = v->orders; order != NULL; order = order->next)
|
|
|
|
|
|
|
|
/* (Un)pack routines */
|
|
|
|
uint32 PackOrder(const Order *order);
|
|
|
|
Order UnpackOrder(uint32 packed);
|
|
|
|
Order UnpackOldOrder(uint16 packed);
|
|
|
|
void AssignOrder(Order *order, Order data);
|
|
|
|
|
|
|
|
#endif /* ORDER_H */
|