-
-
Notifications
You must be signed in to change notification settings - Fork 531
/
orderdef.h
204 lines (184 loc) · 11.7 KB
/
orderdef.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
/*
This file is part of Warzone 2100.
Copyright (C) 1999-2004 Eidos Interactive
Copyright (C) 2005-2020 Warzone 2100 Project
Warzone 2100 is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
Warzone 2100 is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with Warzone 2100; if not, write to the Free Software
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
*/
/**
*
* @file
* Order related structures.
*
*/
#ifndef __INCLUDED_SRC_ORDERDEF_H__
#define __INCLUDED_SRC_ORDERDEF_H__
#include "lib/framework/vector.h"
#include "basedef.h"
class DROID_GROUP;
struct BASE_OBJECT;
struct BASE_STATS;
struct DROID;
struct STRUCTURE;
struct STRUCTURE_STATS;
/** All the possible droid orders.
* @todo DORDER_CIRCLE = 40 which is not consistent with rest of the enum.
*/
enum DroidOrderType
{
DORDER_NONE, /**< no order set. */
DORDER_STOP, /**< stop the current order. */
DORDER_MOVE, /**< 2 - move to a location. */
DORDER_ATTACK, /**< attack an enemy. */
DORDER_BUILD, /**< 4 - build a structure. */
DORDER_HELPBUILD, /**< help to build a structure. */
DORDER_LINEBUILD, /**< 6 - build a number of structures in a row (walls + bridges). */
DORDER_DEMOLISH, /**< demolish a structure. */
DORDER_REPAIR, /**< 8 - repair a structure. */
DORDER_OBSERVE, /**< keep a target in sensor view. */
DORDER_FIRESUPPORT, /**< 10 - attack whatever the linked sensor droid attacks. */
DORDER_UNUSED_4,
DORDER_UNUSED_2,
DORDER_RTB, /**< return to base. */
DORDER_RTR, /**< 14 - return to repair at any repair facility*/
DORDER_UNUSED_5,
DORDER_EMBARK, /**< 16 - board a transporter. */
DORDER_DISEMBARK, /**< get off a transporter. */
DORDER_ATTACKTARGET, /**< 18 - a suggestion to attack something i.e. the target was chosen because the droid could see it. */
DORDER_COMMANDERSUPPORT,/**< Assigns droid to the target commander. */
DORDER_BUILDMODULE, /**< 20 - build a module (power, research or factory). */
DORDER_RECYCLE, /**< return to factory to be recycled. */
DORDER_TRANSPORTOUT, /**< 22 - offworld transporter order. */
DORDER_TRANSPORTIN, /**< onworld transporter order. */
DORDER_TRANSPORTRETURN, /**< 24 - transporter return after unloading. */
DORDER_GUARD, /**< guard a structure. */
DORDER_DROIDREPAIR, /**< 26 - repair a droid. */
DORDER_RESTORE, /**< restore resistance points for a structure. */
DORDER_SCOUT, /**< 28 - same as move, but stop if an enemy is seen. */
DORDER_UNUSED_3,
DORDER_UNUSED,
DORDER_PATROL, /**< move between two way points. */
DORDER_REARM, /**< 32 - order a vtol to rearming pad. */
DORDER_RECOVER, /**< pick up an artifact. */
DORDER_UNUSED_6,
DORDER_RTR_SPECIFIED, /**< return to repair at a specified repair center. */
DORDER_CIRCLE = 40, /**< circles target location and engage. */
DORDER_HOLD, /**< hold position until given next order. */
};
typedef DroidOrderType DROID_ORDER;
/** All the possible secondary orders for droids. */
enum SECONDARY_ORDER
{
DSO_UNUSED,
DSO_ATTACK_RANGE, /**< The attack range a given droid is allowed to fire: can be short, long or optimum (best chance to hit). Used with DSS_ARANGE_SHORT, DSS_ARANGE_LONG, DSS_ARANGE_OPTIMUM. */
DSO_REPAIR_LEVEL, /**< The repair level at which the droid falls back to repair: can be low, high or never. Used with DSS_REPLEV_LOW, DSS_REPLEV_HIGH, DSS_REPLEV_NEVER. */
DSO_ATTACK_LEVEL, /**< The attack level at which a droid can attack: can be always, attacked or never. Used with DSS_ALEV_ALWAYS, DSS_ALEV_ATTACKED, DSS_ALEV_NEVER. */
DSO_ASSIGN_PRODUCTION, /**< Assigns a factory to a command droid - the state is given by the factory number. */
DSO_ASSIGN_CYBORG_PRODUCTION, /**< Assigns a cyborg factory to a command droid - the state is given by the factory number. */
DSO_CLEAR_PRODUCTION, /**< Removes the production from a command droid. */
DSO_RECYCLE, /**< If can be recycled or not. */
DSO_PATROL, /**< If it is assigned to patrol between current pos and next move target. */
DSO_HALTTYPE, /**< The type of halt. It can be hold, guard or pursue. Used with DSS_HALT_HOLD, DSS_HALT_GUARD, DSS_HALT_PURSUE. */
DSO_RETURN_TO_LOC, /**< Generic secondary order to return to a location. Will depend on the secondary state DSS_RTL* to be specific. */
DSO_FIRE_DESIGNATOR, /**< Assigns a droid to be a target designator. */
DSO_ASSIGN_VTOL_PRODUCTION, /**< Assigns a vtol factory to a command droid - the state is given by the factory number. */
DSO_CIRCLE, /**< circling target position and engage. */
DSO_ACCEPT_RETREP /**< Whether droids should retreat to this repair droid. */
};
/** All associated secondary states of the secondary orders. */
enum SECONDARY_STATE
{
DSS_NONE = 0x000000, /**< no state. */
DSS_ARANGE_SHORT = 0x000001, /**< state referred to secondary order DSO_ATTACK_RANGE. Droid can only attack with short range. */
DSS_ARANGE_LONG = 0x000002, /**< state referred to secondary order DSO_ATTACK_RANGE. Droid can only attack with long range. */
DSS_ARANGE_OPTIMUM = 0x000003, /**< state referred to secondary order DSO_ATTACK_RANGE. Droid can attacks with short or long range depending on what is the best hit chance. */
DSS_REPLEV_LOW = 0x000004, /**< state referred to secondary order DSO_REPAIR_LEVEL. Droid falls back if its health decrease below 25%. */
DSS_REPLEV_HIGH = 0x000008, /**< state referred to secondary order DSO_REPAIR_LEVEL. Droid falls back if its health decrease below 50%. */
DSS_REPLEV_NEVER = 0x00000c, /**< state referred to secondary order DSO_REPAIR_LEVEL. Droid never falls back. */
DSS_ALEV_ALWAYS = 0x000010, /**< state referred to secondary order DSO_ATTACK_LEVEL. Droid attacks by its free will everytime. */
DSS_ALEV_ATTACKED = 0x000020, /**< state referred to secondary order DSO_ATTACK_LEVEL. Droid attacks if it is attacked. */
DSS_ALEV_NEVER = 0x000030, /**< state referred to secondary order DSO_ATTACK_LEVEL. Droid never attacks. */
DSS_HALT_HOLD = 0x000040, /**< state referred to secondary order DSO_HALTTYPE. If halted, droid never moves by its free will. */
DSS_HALT_GUARD = 0x000080, /**< state referred to secondary order DSO_HALTTYPE. If halted, droid moves on a given region by its free will. */
DSS_HALT_PURSUE = 0x0000c0, /**< state referred to secondary order DSO_HALTTYPE. If halted, droid pursues the target by its free will. */
DSS_RECYCLE_SET = 0x000100, /**< state referred to secondary order DSO_RECYCLE. If set, the droid can be recycled. */
DSS_ASSPROD_START = 0x000200, /**< @todo this state is not called on the code. Consider removing it. */
DSS_ACCREP_SET = 0x000400, /**< state referred to secondary order DSO_ACCEPT_RETREP. If set, units will retreat to this repair droid. */
DSS_ASSPROD_MID = 0x002000, /**< @todo this state is not called on the code. Consider removing it. */
DSS_ASSPROD_END = 0x040000, /**< @todo this state is not called on the code. Consider removing it. */
DSS_RTL_REPAIR = 0x080000, /**< state set to send order DORDER_RTR to droid. */
DSS_RTL_BASE = 0x100000, /**< state set to send order DORDER_RTB to droid. */
DSS_RTL_TRANSPORT = 0x200000, /**< state set to send order DORDER_EMBARK to droid. */
DSS_PATROL_SET = 0x400000, /**< state referred to secondary order DSO_PATROL. If set, the droid is set to patrol. */
DSS_CIRCLE_SET = 0x400100, /**< state referred to secondary order DSO_CIRCLE. If set, the droid is set to circle. */
DSS_FIREDES_SET = 0x800000, /**< state referred to secondary order DSO_FIRE_DESIGNATOR. If set, the droid is set as a fire designator. */
};
/** masks for the secondary order state. */
#define DSS_ARANGE_MASK 0x000003
#define DSS_REPLEV_MASK 0x00000c
#define DSS_ALEV_MASK 0x000030
#define DSS_HALT_MASK 0x0000c0
#define DSS_RECYCLE_MASK 0x000100
#define DSS_ASSPROD_MASK 0x1f07fe00
#define DSS_ASSPROD_FACT_MASK 0x003e00
#define DSS_ASSPROD_CYB_MASK 0x07c000
#define DSS_ASSPROD_VTOL_MASK 0x1f000000
#define DSS_ASSPROD_SHIFT 9
#define DSS_ASSPROD_CYBORG_SHIFT (DSS_ASSPROD_SHIFT + 5)
#define DSS_ASSPROD_VTOL_SHIFT 24
#define DSS_RTL_MASK 0x380000
#define DSS_PATROL_MASK 0x400000
#define DSS_FIREDES_MASK 0x800000
#define DSS_CIRCLE_MASK 0x400100
#define DSS_ACCREP_MASK 0x000400
struct STRUCTURE_STATS;
enum RTR_DATA_TYPE
{
RTR_TYPE_NO_RESULT,
RTR_TYPE_REPAIR_FACILITY,
RTR_TYPE_DROID,
RTR_TYPE_HQ,
// If modifying, only *add* entries at end! (or savegame loading will break)
};
/** Struct that stores data of an order.
* This struct is needed to send orders that comes with information, such as position, target, etc.
* This struct is used to issue orders to droids.
*/
struct DroidOrder
{
explicit DroidOrder(DroidOrderType type = DORDER_NONE)
: type(type), pos(0, 0), pos2(0, 0), direction(0), index(0), rtrType(RTR_TYPE_NO_RESULT), psObj(nullptr), psStats(nullptr) {}
DroidOrder(DroidOrderType type, Vector2i pos)
: type(type), pos(pos), pos2(0, 0), direction(0), index(0), rtrType(RTR_TYPE_NO_RESULT), psObj(nullptr), psStats(nullptr) {}
DroidOrder(DroidOrderType type, Vector2i pos, RTR_DATA_TYPE rtrType)
: type(type), pos(pos), pos2(0, 0), direction(0), index(0), rtrType(rtrType), psObj(nullptr), psStats(nullptr) {}
DroidOrder(DroidOrderType type, STRUCTURE_STATS *psStats, Vector2i pos, uint16_t direction)
: type(type), pos(pos), pos2(0, 0), direction(direction), index(0), rtrType(RTR_TYPE_NO_RESULT), psObj(nullptr), psStats(psStats) {}
DroidOrder(DroidOrderType type, STRUCTURE_STATS *psStats, Vector2i pos, Vector2i pos2, uint16_t direction)
: type(type), pos(pos), pos2(pos2), direction(direction), index(0), rtrType(RTR_TYPE_NO_RESULT), psObj(nullptr), psStats(psStats) {}
DroidOrder(DroidOrderType type, BASE_OBJECT *psObj)
: type(type), pos(0, 0), pos2(0, 0), direction(0), index(0), rtrType(RTR_TYPE_NO_RESULT), psObj(psObj), psStats(nullptr) {}
DroidOrder(DroidOrderType type, BASE_OBJECT *psObj, RTR_DATA_TYPE rtrType)
: type(type), pos(0, 0), pos2(0, 0), direction(0), index(0), rtrType(rtrType), psObj(psObj), psStats(nullptr) {}
DroidOrder(DroidOrderType type, BASE_OBJECT *psObj, uint32_t index)
: type(type), pos(0, 0), pos2(0, 0), direction(0), index(index), rtrType(RTR_TYPE_NO_RESULT), psObj(psObj), psStats(nullptr) {}
DroidOrderType type; /**< the actual order. */
Vector2i pos; /**< the order's position. */
Vector2i pos2; /**< the order's second position, in case those exist. */
uint16_t direction; /**< the order's direction, in case it exist. */
uint32_t index; ///< Module index, with DORDER_BUILDMODULE.
RTR_DATA_TYPE rtrType; /**< specifies where to repair. */
BASE_OBJECT *psObj; /**< the order's target, in case it exist. */
STRUCTURE_STATS *psStats; /**< order structure stats. */
};
typedef DroidOrder DROID_ORDER_DATA;
#endif // __INCLUDED_SRC_ORDERDEF_H__