-
-
Notifications
You must be signed in to change notification settings - Fork 62
/
actions.rs
376 lines (345 loc) · 12.5 KB
/
actions.rs
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
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
/*!
Defines Action-related functionality. This module includes the ActionBuilder trait and some Composite Actions for utility.
*/
use std::sync::Arc;
use bevy::prelude::*;
use crate::thinker::{ActionEnt, Actor};
/**
The current state for an Action.
*/
#[derive(Debug, Clone, Eq, PartialEq)]
pub enum ActionState {
/**
Initial state. No action should be performed.
*/
Init,
/**
Action requested. The Action-handling system should start executing this Action ASAP and change the status to the next state.
*/
Requested,
/**
The action has ongoing execution. The associated Thinker will try to keep executing this Action as-is until it changes state or it gets Cancelled.
*/
Executing,
/**
An ongoing Action has been cancelled. The Thinker might set this action for you, so for Actions that execute for longer than a single tick, **you must check whether the Cancelled state was set** and change do either Success or Failure. Thinkers will wait on Cancelled actions to do any necessary cleanup work, so this can hang your AI if you don't look for it.
*/
Cancelled,
/**
The Action was a success. This is used by Composite Actions to determine whether to continue execution.
*/
Success,
/**
The Action failed. This is used by Composite Actions to determine whether to halt execution.
*/
Failure,
}
impl Default for ActionState {
fn default() -> Self {
Self::Init
}
}
impl ActionState {
pub fn new() -> Self {
Self::default()
}
}
#[derive(Debug, Clone, Eq, PartialEq)]
pub(crate) struct ActionBuilderId;
#[derive(Debug, Clone)]
pub(crate) struct ActionBuilderWrapper(pub Arc<ActionBuilderId>, pub Arc<dyn ActionBuilder>);
impl ActionBuilderWrapper {
pub fn new(builder: Arc<dyn ActionBuilder>) -> Self {
ActionBuilderWrapper(Arc::new(ActionBuilderId), builder)
}
}
/**
Trait that must be defined by types in order to be `ActionBuilder`s. `ActionBuilder`s' job is to spawn new `Action` entities. In general, most of this is already done for you, and the only method you really have to implement is `.build()`.
The `build()` method MUST be implemented for any `ActionBuilder`s you want to define.
*/
pub trait ActionBuilder: std::fmt::Debug + Send + Sync {
/**
MUST insert your concrete Action component into the `action` [`Entity`], using `cmd`. You _may_ use `actor`, but it's perfectly normal to just ignore it.
### Example
```no_run
struct MyBuilder;
struct MyAction;
impl ActionBuilder for MyBuilder {
fn build(&self, cmd: &mut Commands, action: Entity, actor: Entity) {
cmd.entity(action).insert(MyAction);
}
}
```
*/
fn build(&self, cmd: &mut Commands, action: Entity, actor: Entity);
/**
Don't implement this yourself unless you know what you're doing.
*/
fn attach(&self, cmd: &mut Commands, actor: Entity) -> Entity {
let action_ent = ActionEnt(cmd.spawn().id());
cmd.entity(action_ent.0)
.insert(Name::new("Action"))
.insert(ActionState::new())
.insert(Actor(actor));
self.build(cmd, action_ent.0, actor);
action_ent.0
}
}
/**
[`ActionBuilder`] for the [`Steps`] component. Constructed through `Steps::build()`.
*/
#[derive(Debug)]
pub struct StepsBuilder {
steps: Vec<Arc<dyn ActionBuilder>>,
}
impl StepsBuilder {
/**
Adds an action step. Order matters.
*/
pub fn step(mut self, action_builder: impl ActionBuilder + 'static) -> Self {
self.steps.push(Arc::new(action_builder));
self
}
}
impl ActionBuilder for StepsBuilder {
fn build(&self, cmd: &mut Commands, action: Entity, actor: Entity) {
if let Some(step) = self.steps.get(0) {
let child_action = step.attach(cmd, actor);
cmd.entity(action)
.insert(Name::new("Steps Action"))
.insert(Steps {
active_step: 0,
active_ent: ActionEnt(child_action),
steps: self.steps.clone(),
})
.push_children(&[child_action]);
}
}
}
/**
Composite Action that executes a series of steps in sequential order, as long as each step results in a `Success`ful [`ActionState`].
### Example
```ignore
Thinker::build()
.when(
MyScorer,
Steps::build()
.step(MyAction::build())
.step(MyNextAction::build())
)
```
*/
#[derive(Debug)]
pub struct Steps {
steps: Vec<Arc<dyn ActionBuilder>>,
active_step: usize,
active_ent: ActionEnt,
}
impl Steps {
/**
Construct a new [`StepsBuilder`] to define the steps to take.
*/
pub fn build() -> StepsBuilder {
StepsBuilder { steps: Vec::new() }
}
}
/**
System that takes care of executing any existing [`Steps`] Actions.
*/
pub fn steps_system(
mut cmd: Commands,
mut steps_q: Query<(Entity, &Actor, &mut Steps)>,
mut states: Query<&mut ActionState>,
) {
use ActionState::*;
for (seq_ent, Actor(actor), mut steps_action) in steps_q.iter_mut() {
let current_state = states.get_mut(seq_ent).expect("uh oh").clone();
match current_state {
Requested => {
// Begin at the beginning
let mut step_state = states.get_mut(steps_action.active_ent.0).expect("oops");
*step_state = Requested;
let mut current_state = states.get_mut(seq_ent).expect("uh oh");
*current_state = Executing;
}
Executing => {
let mut step_state = states.get_mut(steps_action.active_ent.0).expect("bug");
match *step_state {
Init => {
// Request it! This... should not really happen? But just in case I'm missing something... :)
*step_state = Requested;
}
Executing | Requested => {
// do nothing. Everything's running as it should.
}
Cancelled | Failure => {
// Cancel ourselves
let step_state = step_state.clone();
let mut seq_state = states.get_mut(seq_ent).expect("idk");
*seq_state = step_state;
cmd.entity(steps_action.active_ent.0).despawn_recursive();
}
Success if steps_action.active_step == steps_action.steps.len() - 1 => {
// We're done! Let's just be successful
let step_state = step_state.clone();
let mut seq_state = states.get_mut(seq_ent).expect("idk");
*seq_state = step_state;
cmd.entity(steps_action.active_ent.0).despawn_recursive();
}
Success => {
// Deactivate current step and go to the next step
cmd.entity(steps_action.active_ent.0).despawn_recursive();
steps_action.active_step += 1;
let step_builder = steps_action.steps[steps_action.active_step].clone();
let step_ent = step_builder.attach(&mut cmd, *actor);
cmd.entity(seq_ent).push_children(&[step_ent]);
let mut step_state = states.get_mut(step_ent).expect("oops");
*step_state = ActionState::Requested;
}
}
}
Cancelled => {
// Cancel current action
let mut step_state = states.get_mut(steps_action.active_ent.0).expect("oops");
*step_state = ActionState::Cancelled;
}
Init | Success | Failure => {
// Do nothing.
}
}
}
}
/**
[`ActionBuilder`] for the [`Concurrent`] component. Constructed through `Concurrent::build()`.
*/
#[derive(Debug)]
pub struct ConcurrentlyBuilder {
actions: Vec<Arc<dyn ActionBuilder>>,
}
impl ConcurrentlyBuilder {
/**
Add an action to execute. Order does not matter.
*/
pub fn push(mut self, action_builder: impl ActionBuilder + 'static) -> Self {
self.actions.push(Arc::new(action_builder));
self
}
}
impl ActionBuilder for ConcurrentlyBuilder {
fn build(&self, cmd: &mut Commands, action: Entity, actor: Entity) {
let children: Vec<Entity> = self
.actions
.iter()
.map(|action| action.attach(cmd, actor))
.collect();
cmd.entity(action)
.insert(Name::new("Concurrent Action"))
.push_children(&children[..])
.insert(Concurrently {
actions: children.into_iter().map(ActionEnt).collect(),
});
}
}
/**
Composite Action that executes a number of Actions concurrently, as long as they all result in a `Success`ful [`ActionState`].
### Example
```ignore
Thinker::build()
.when(
MyScorer,
Concurrent::build()
.push(MyAction::build())
.push(MyOtherAction::build())
)
```
*/
#[derive(Debug)]
pub struct Concurrently {
actions: Vec<ActionEnt>,
}
impl Concurrently {
/**
Construct a new [`ConcurrentBuilder`] to define the actions to take.
*/
pub fn build() -> ConcurrentlyBuilder {
ConcurrentlyBuilder {
actions: Vec::new(),
}
}
}
/**
System that takes care of executing any existing [`Concurrent`] Actions.
*/
pub fn concurrent_system(
concurrent_q: Query<(Entity, &Concurrently)>,
mut states_q: Query<&mut ActionState>,
) {
use ActionState::*;
for (seq_ent, concurrent_action) in concurrent_q.iter() {
let current_state = states_q.get_mut(seq_ent).expect("uh oh").clone();
match current_state {
Requested => {
// Begin at the beginning
let mut current_state = states_q.get_mut(seq_ent).expect("uh oh");
*current_state = Executing;
for ActionEnt(child_ent) in concurrent_action.actions.iter() {
let mut child_state = states_q.get_mut(*child_ent).expect("uh oh");
*child_state = Requested;
}
}
Executing => {
let mut all_success = true;
let mut failed_idx = None;
for (idx, ActionEnt(child_ent)) in concurrent_action.actions.iter().enumerate() {
let mut child_state = states_q.get_mut(*child_ent).expect("uh oh");
match *child_state {
Failure => {
failed_idx = Some(idx);
all_success = false;
}
Success => {}
_ => {
all_success = false;
if failed_idx.is_some() {
*child_state = Cancelled;
}
}
}
}
if all_success {
let mut state_var = states_q.get_mut(seq_ent).expect("uh oh");
*state_var = Success;
} else if let Some(idx) = failed_idx {
for ActionEnt(child_ent) in concurrent_action.actions.iter().take(idx) {
let mut child_state = states_q.get_mut(*child_ent).expect("uh oh");
match *child_state {
Failure | Success => {}
_ => {
*child_state = Cancelled;
}
}
}
let mut state_var = states_q.get_mut(seq_ent).expect("uh oh");
*state_var = Failure;
}
}
Cancelled => {
// Cancel all actions
for ActionEnt(child_ent) in concurrent_action.actions.iter() {
let mut child_state = states_q.get_mut(*child_ent).expect("uh oh");
match *child_state {
Init | Success | Failure => {
// Do nothing
}
_ => {
*child_state = Cancelled;
}
}
}
}
Init | Success | Failure => {
// Do nothing.
}
}
}
}