shipyard 0.11.2

Entity Component System
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

# Iterators


Iteration is one of the most important features of an ECS.

## World


```rust, noplaypen
{{#include ../../../../tests/book/iterators.rs:world}}
```

The "extra" `&mut` is unfortunate but necessary.

## Views


Iteration on views is achieved using [`IntoIter::iter`](https://docs.rs/shipyard/0.10/shipyard/trait.IntoIter.html#tymethod.iter).

```rust, noplaypen
{{#include ../../../../tests/book/iterators.rs:iter}}
```

You can use views in any order. However, using the same combination of views in different positions may yield components in a different order.\
You shouldn't expect specific ordering from Shipyard's iterators in general.

#### With Id


You can ask an iterator to tell you which entity owns each component by using [`WithId::with_id`](https://docs.rs/shipyard/0.10/shipyard/trait.IntoWithId.html#method.with_id):

```rust, noplaypen
{{#include ../../../../tests/book/iterators.rs:with_id}}
```

#### Not


It's possible to filter entities that don't have a certain component using [`Not`](https://docs.rs/shipyard/0.10/shipyard/struct.Not.html) by adding `!` in front of the view reference.

```rust, noplaypen
{{#include ../../../../tests/book/iterators.rs:not}}
```