Skip to content

Commit

Permalink
minor rewordings
Browse files Browse the repository at this point in the history
  • Loading branch information
inodentry committed Mar 29, 2021
1 parent 0ecf2e9 commit e0b83f8
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 10 deletions.
4 changes: 2 additions & 2 deletions src/introduction.md
Expand Up @@ -6,9 +6,9 @@ Covers useful syntax, features, programming patterns, and solutions for common g

Designed to be easy to read, straight to the point, using simple language to focus on the important information.

It is not intended to be read in order. Jump to whatever is useful to you!
Not intended to be read in order. Jump to whatever is useful to you!

The book is not exhaustive / complete. It is my best attempt to cover the most practically-relevant aspects.
It is not exhaustive / complete. It is my best attempt to cover the most practically-relevant aspects.

The book has several sections:

Expand Down
7 changes: 4 additions & 3 deletions src/programming/change-detection.md
Expand Up @@ -26,9 +26,10 @@ detection. If you want to avoid that, simply check it yourself:

## Possible Pitfalls

Beware of [frame delay / 1-frame-lag](../pitfalls/frame-delay.md). If Bevy runs
the detecting system before the changing system, the detecting system will
see the change on the next frame update.
Beware of [frame delay / 1-frame-lag](../pitfalls/frame-delay.md). This can
occur if Bevy runs the detecting system before the changing system. The
detecting system will see the change the next time it runs, typically on the
next frame update.

If you need to ensure that changes are handled immediately / during the same frame,
you can use [explicit system ordering](./system-order.md).
11 changes: 6 additions & 5 deletions src/programming/events.md
@@ -1,10 +1,11 @@
# Events

Send data between systems, to let your systems communicate with each other!
Send data between systems! Let your systems communicate with each other!

To send events, use an `EventWriter<T>`. To receive events, use an `EventReader<T>`.

Every reader tracks the events it has read independently, so you can handle the same events from multiple systems.
Every reader tracks the events it has read independently, so you can handle the
same events from multiple systems.

```rust,no_run,noplayground
{{#include ../code/src/basics.rs:events}}
Expand All @@ -22,9 +23,9 @@ miss some.
The advantage of this design is that you don't have to worry about excessive
memory use from unhandled events.

Also beware of [frame delay / 1-frame-lag](../pitfalls/frame-delay.md). If Bevy runs
the receiving system before the sending system, the events will be received on
the next frame update.
Also beware of [frame delay / 1-frame-lag](../pitfalls/frame-delay.md). This can
occur if Bevy runs the receiving system before the sending system. The receiving
system will get the events the next time it runs, typically on the next frame update.

If you need to ensure that events are handled immediately / during the same frame,
you can use [explicit system ordering](./system-order.md).

0 comments on commit e0b83f8

Please sign in to comment.