screeps-async 0.2.0

Tick-aware Async runtime for Screeps
Documentation 
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

# Screeps Async
Tick-aware Async Runtime for Screeps

[![Crates.io][crates-badge]][crates-url]
[![CI][actions-badge]][actions-url]

[crates-badge]: https://img.shields.io/crates/v/screeps-async.svg
[crates-url]: https://crates.io/crates/screeps-async
[actions-badge]: https://github.com/rustyscreeps/screeps-async/actions/workflows/ci.yml/badge.svg
[actions-url]: https://github.com/rustyscreeps/screeps-async/actions/workflows/ci.yml

### Getting Started
Add `screeps-async` to your `Cargo.toml`
```toml
[dependencies]
screeps-async = "0.2.0"
```

**IMPORTANT**: This project is very much in an early stage and significant, breaking changes may
be made between alpha versions.

Add `#[screeps_async::main]` to your main loop function and start spawning async code!
```rust
#[screeps_async::main] // must be before other attributes to work properly
#[wasm_bindgen(js_name = loop)]
pub fn game_loop() {
    // Tick logic that spawns some tasks
    screeps_async::spawn(async {
        println!("Hello!");
    });
}
```

### The `each_tick!` macro 

In synchronous Screeps code, one common pattern is to use a state machine and decide what logic to use based off the state.
With asynchronous programming you are liberated from the shackles of the tick and free to write a single function whose
execution spans across ticks. This allows you to "unroll" a state machine into a single function that execute top-to-bottom.
In such cases you will likely still need to write code that loops each tick until moving on (ie repeatedly calling `move_to`).

However, it is not safe to store references to `RoomObjects` across ticks as they may be destroyed/go out of vision. 
The solution to this problem is to store `ObjectId`s instead and `.resolve()` them each tick.

The `each_tick!` macro may be used to help reduce the boilerplate of looping and `.resolve()`'ing each tick. 
`each_tick!` accepts a list of dependencies (usually `ObjectId`s) and will call `.resolve()` on them each tick, making the
resolved value available to the provided code block under the same name as the dependency (see example for details)


```rust
async fn collect_and_upgrade(creep: ObjectId<Creep>, source: ObjectId<Source>, controller: ObjectId<StructureController>) {
    // Collect until full
    each_tick!(creep, source, {
        if creep.store().get_free_capacity(Some(ResourceType::Energy)) == 0 {
            return Some(());
        }
        
        if let Err(_) = creep.harvest(&source) {
            let _ = creep.move_to(&source);
        }
        
        // Do this forever
        None
    }).await.expect("Creep or source is gone!");
    
    each_tick!(creep, controller, {
        if creep.store().get_used_capacity(Some(ResourceType::Energy)) == 0 {
            return Some(());
        }
        
        if let Err(_) = creep.upgrade_controller(&controller) {
            let _ = creep.move_to(&controller);
        }
        
        // Do this forever
        None
    }).await.expect("Creep or controller is gone!");
}

```