dave/openttd
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Document uses of xflags and xdata in OrderExtraInfo

Browse Source
This commit is contained in:
Jonathan G Rennison
2023-04-09 11:22:09 +01:00
parent 2ff513f0cd
commit 23319fbd4a
1 changed files with 21 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
src/order_base.h
View File

@@ -51,6 +51,27 @@ template <typename F> void IterateOrderRefcountMapForDestinationID(DestinationID
void IntialiseOrderDestinationRefcountMap();
void ClearOrderDestinationRefcountMap();
/*
* xflags bits:
* Bit 0: OT_CONDITIONAL: IsWaitTimetabled(): For branch travel time
* Bit 1: IsWaitFixed(): Wait time fixed
* Bits 2-3: GetLeaveType(): Order leave type
* Bit 4: IsTravelFixed(): Travel time fixed
* Bits 5-7: GetRoadVehTravelDirection(): Road vehicle travel direction
*/
/*
* xdata users:
* OT_COUNTER: Counter operation value (not counter ID)
* OCV_SLOT_OCCUPANCY, OCV_VEH_IN_SLOT: Trace restrict slot ID
* OCV_COUNTER_VALUE: Bits 0-15: Counter comparison value, Bits 16-31: Counter ID
* OCV_TIMETABLE: Timetable lateness/earliness
* OCV_TIME_DATE: Time/date
* OCV_CARGO_WAITING_AMOUNT: Bits 0-15: Cargo quantity comparison value, Bits 16-31: Via station ID + 2
* OCV_CARGO_LOAD_PERCENTAGE: Cargo percentage comparison value
* OCV_DISPATCH_SLOT: Bits 0-15: Dispatch schedule ID
* OCV_PERCENT: Bits 0-7: Jump counter
*/
struct OrderExtraInfo {
uint8 cargo_type_flags[NUM_CARGO] = {}; ///< Load/unload types for each cargo type.
uint32 xdata = 0; ///< Extra arbitrary data