bevy/crates/bevy_ecs/src
lelo 42e6dc8987
Refactor EventReader::iter to read (#9631)
# Objective

- The current `EventReader::iter` has been determined to cause confusion
among new Bevy users. It was suggested by @JoJoJet to rename the method
to better clarify its usage.
- Solves #9624 

## Solution

- Rename `EventReader::iter` to `EventReader::read`.
- Rename `EventReader::iter_with_id` to `EventReader::read_with_id`.
- Rename `ManualEventReader::iter` to `ManualEventReader::read`.
- Rename `ManualEventReader::iter_with_id` to
`ManualEventReader::read_with_id`.

---

## Changelog

- `EventReader::iter` has been renamed to `EventReader::read`.
- `EventReader::iter_with_id` has been renamed to
`EventReader::read_with_id`.
- `ManualEventReader::iter` has been renamed to
`ManualEventReader::read`.
- `ManualEventReader::iter_with_id` has been renamed to
`ManualEventReader::read_with_id`.
- Deprecated `EventReader::iter`
- Deprecated `EventReader::iter_with_id`
- Deprecated `ManualEventReader::iter`
- Deprecated `ManualEventReader::iter_with_id`

## Migration Guide

- Existing usages of `EventReader::iter` and `EventReader::iter_with_id`
will have to be changed to `EventReader::read` and
`EventReader::read_with_id` respectively.
- Existing usages of `ManualEventReader::iter` and
`ManualEventReader::iter_with_id` will have to be changed to
`ManualEventReader::read` and `ManualEventReader::read_with_id`
respectively.
2023-08-30 14:20:03 +00:00
..
entity Allow disjoint mutable world access via EntityMut (#9419) 2023-08-28 23:30:59 +00:00
query Allow disjoint mutable world access via EntityMut (#9419) 2023-08-28 23:30:59 +00:00
reflect Allow disjoint mutable world access via EntityMut (#9419) 2023-08-28 23:30:59 +00:00
schedule Refactor EventReader::iter to read (#9631) 2023-08-30 14:20:03 +00:00
storage Fix typos throughout the project (#9090) 2023-07-10 00:11:51 +00:00
system Allow disjoint mutable world access via EntityMut (#9419) 2023-08-28 23:30:59 +00:00
world Allow disjoint mutable world access via EntityMut (#9419) 2023-08-28 23:30:59 +00:00
archetype.rs Allow disjoint mutable world access via EntityMut (#9419) 2023-08-28 23:30:59 +00:00
bundle.rs Document every public item in bevy_ecs (#8731) 2023-06-10 23:23:48 +00:00
change_detection.rs Move schedule name into Schedule (#9600) 2023-08-28 20:44:48 +00:00
component.rs Derive Eq, PartialEq for Tick (#9020) 2023-07-04 19:08:51 +00:00
event.rs Refactor EventReader::iter to read (#9631) 2023-08-30 14:20:03 +00:00
lib.rs Allow disjoint mutable world access via EntityMut (#9419) 2023-08-28 23:30:59 +00:00
removal_detection.rs Refactor EventReader::iter to read (#9631) 2023-08-30 14:20:03 +00:00