[Merged by Bors] - Add helpers to send `Events` from `World` #5355

aevyrie · 2022-07-17T16:04:44Z

Objective

With access to World, it's not obvious how to send an event.
This is especially useful if you are writing a Command that needs to send an Event.
Events are a first-class construct in bevy, even though they are just Resources under the hood. Their methods should be discoverable.

Solution

Provide a simple helpers to send events through Res<Events<T>>.

Changelog

send_event, send_default_event, and send_event_batch methods added to World.

alice-i-cecile · 2022-07-17T16:31:35Z

send_event and send_default_event for legibility please :)

crates/bevy_ecs/src/world/mod.rs

alice-i-cecile · 2022-07-17T16:34:11Z

Previously attempted in #3839.

Nilirad

I have mixed feelings about using the noun-verb grammar, but I wouldn't block that.

I would have suggested you to link to EventWriter examples, but there are none. 😐

crates/bevy_ecs/src/world/mod.rs

Co-authored-by: Federico Rinaldi <gisquerin@gmail.com>

mockersf

Could you also add the send_batch method to have the same features that the EventWriter?

Nilirad

I prefer to write “Event” in monospace since we're linking to the trait itself and we're passing a type that implements it as an argument.

I'm OK for now to link to the trait instead of the module in the docs, since there is practically no documentation at the module level. This can be changed later with an event docs overhaul.

I prefer that the suggestion made in this comment should be applied before merging.

crates/bevy_ecs/src/world/mod.rs

Co-authored-by: Federico Rinaldi <gisquerin@gmail.com>

aevyrie · 2022-07-19T01:38:17Z

Added send_batch. I refactored the other two methods as special cases of send_batch to keep the error checks nice and DRY. 😛

crates/bevy_ecs/src/world/mod.rs

alice-i-cecile · 2022-07-19T20:53:47Z

bors r+

# Objective - With access to `World`, it's not obvious how to send an event. - This is especially useful if you are writing a `Command` that needs to send an `Event`. - `Events` are a first-class construct in bevy, even though they are just `Resources` under the hood. Their methods should be discoverable. ## Solution - Provide a simple helpers to send events through `Res<Events<T>>`. --- ## Changelog > `send_event`, `send_default_event`, and `send_event_batch` methods added to `World`.

bors · 2022-07-19T21:13:20Z

Pull request successfully merged into main.

Build succeeded:

mockersf · 2022-07-19T21:30:34Z

missed to propose a rename before this was merged: #5383

after #5355, three methods were added on world: * `send_event` * `send_event_batch` * `send_default_event` rename `send_default_event` to `send_event_default` for better discoverability

# Objective - With access to `World`, it's not obvious how to send an event. - This is especially useful if you are writing a `Command` that needs to send an `Event`. - `Events` are a first-class construct in bevy, even though they are just `Resources` under the hood. Their methods should be discoverable. ## Solution - Provide a simple helpers to send events through `Res<Events<T>>`. --- ## Changelog > `send_event`, `send_default_event`, and `send_event_batch` methods added to `World`.

…5383) after bevyengine#5355, three methods were added on world: * `send_event` * `send_event_batch` * `send_default_event` rename `send_default_event` to `send_event_default` for better discoverability

# Objective - With access to `World`, it's not obvious how to send an event. - This is especially useful if you are writing a `Command` that needs to send an `Event`. - `Events` are a first-class construct in bevy, even though they are just `Resources` under the hood. Their methods should be discoverable. ## Solution - Provide a simple helpers to send events through `Res<Events<T>>`. --- ## Changelog > `send_event`, `send_default_event`, and `send_event_batch` methods added to `World`.

…5383) after bevyengine#5355, three methods were added on world: * `send_event` * `send_event_batch` * `send_default_event` rename `send_default_event` to `send_event_default` for better discoverability

# Objective - With access to `World`, it's not obvious how to send an event. - This is especially useful if you are writing a `Command` that needs to send an `Event`. - `Events` are a first-class construct in bevy, even though they are just `Resources` under the hood. Their methods should be discoverable. ## Solution - Provide a simple helpers to send events through `Res<Events<T>>`. --- ## Changelog > `send_event`, `send_default_event`, and `send_event_batch` methods added to `World`.

…5383) after bevyengine#5355, three methods were added on world: * `send_event` * `send_event_batch` * `send_default_event` rename `send_default_event` to `send_event_default` for better discoverability

# Objective Use the `World::send_event` method added in #5355 to simplify a doc example for `EventWriter`.

add event sending helpers to World

85196b3

aevyrie added A-ECS Entities, components, systems, and events C-Usability A simple quality-of-life change that makes Bevy easier to use labels Jul 17, 2022

make doc comments concise

db03697

aevyrie changed the title ~~add event sending helpers to World~~ Add helpers to send Events from World Jul 17, 2022

aevyrie marked this pull request as ready for review July 17, 2022 16:14

alice-i-cecile reviewed Jul 17, 2022

View reviewed changes

crates/bevy_ecs/src/world/mod.rs Outdated Show resolved Hide resolved

alice-i-cecile reviewed Jul 17, 2022

View reviewed changes

crates/bevy_ecs/src/world/mod.rs Outdated Show resolved Hide resolved

Nilirad approved these changes Jul 17, 2022

View reviewed changes

crates/bevy_ecs/src/world/mod.rs Outdated Show resolved Hide resolved

crates/bevy_ecs/src/world/mod.rs Outdated Show resolved Hide resolved

crates/bevy_ecs/src/world/mod.rs Outdated Show resolved Hide resolved

IceSentry reviewed Jul 17, 2022

View reviewed changes

crates/bevy_ecs/src/world/mod.rs Outdated Show resolved Hide resolved

aevyrie and others added 2 commits July 17, 2022 11:25

Update crates/bevy_ecs/src/world/mod.rs

729d3d2

Co-authored-by: Federico Rinaldi <gisquerin@gmail.com>

Update crates/bevy_ecs/src/world/mod.rs

62512d5

Co-authored-by: Federico Rinaldi <gisquerin@gmail.com>

IceSentry approved these changes Jul 17, 2022

View reviewed changes

Improve error message and deduplicate

e4b489c

aevyrie force-pushed the world-event-helpers branch from 2a57b6a to e4b489c Compare July 17, 2022 19:16

aevyrie added the S-Ready-For-Final-Review This PR has been approved by the community. It's ready for a maintainer to consider merging it label Jul 17, 2022

mockersf requested changes Jul 18, 2022

View reviewed changes

Nilirad suggested changes Jul 18, 2022

View reviewed changes

crates/bevy_ecs/src/world/mod.rs Outdated Show resolved Hide resolved

crates/bevy_ecs/src/world/mod.rs Outdated Show resolved Hide resolved

Nilirad removed the S-Ready-For-Final-Review This PR has been approved by the community. It's ready for a maintainer to consider merging it label Jul 18, 2022

aevyrie and others added 3 commits July 18, 2022 12:12

Update crates/bevy_ecs/src/world/mod.rs

1371e2c

Co-authored-by: Federico Rinaldi <gisquerin@gmail.com>

Update crates/bevy_ecs/src/world/mod.rs

973bbdf

Co-authored-by: Federico Rinaldi <gisquerin@gmail.com>

add send_batch

3e6ae21

aevyrie added the S-Ready-For-Final-Review This PR has been approved by the community. It's ready for a maintainer to consider merging it label Jul 19, 2022

alice-i-cecile approved these changes Jul 19, 2022

View reviewed changes

Nilirad reviewed Jul 19, 2022

View reviewed changes

crates/bevy_ecs/src/world/mod.rs Outdated Show resolved Hide resolved

Rename send_batch to send_event_batch

3eaf8d8

bors bot changed the title ~~Add helpers to send Events from World~~ [Merged by Bors] - Add helpers to send Events from World Jul 19, 2022

bors bot closed this Jul 19, 2022

mockersf mentioned this pull request Jul 19, 2022

[Merged by Bors] - rename send_default_event to send_event_default on world #5383

Closed

JoJoJet mentioned this pull request Feb 7, 2023

[Merged by Bors] - Simplify a doc example for EventWriter #7549

Closed

bors bot pushed a commit that referenced this pull request Feb 7, 2023

Simplify a doc example for EventWriter (#7549)

5d2cd08

# Objective Use the `World::send_event` method added in #5355 to simplify a doc example for `EventWriter`.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Merged by Bors] - Add helpers to send `Events` from `World` #5355

[Merged by Bors] - Add helpers to send `Events` from `World` #5355

aevyrie commented Jul 17, 2022 •

edited

Loading

alice-i-cecile commented Jul 17, 2022

alice-i-cecile commented Jul 17, 2022

Nilirad left a comment

mockersf left a comment

Nilirad left a comment

aevyrie commented Jul 19, 2022

alice-i-cecile commented Jul 19, 2022

bors bot commented Jul 19, 2022

mockersf commented Jul 19, 2022

[Merged by Bors] - Add helpers to send Events from World #5355

[Merged by Bors] - Add helpers to send Events from World #5355

Conversation

aevyrie commented Jul 17, 2022 • edited Loading

Objective

Solution

Changelog

alice-i-cecile commented Jul 17, 2022

alice-i-cecile commented Jul 17, 2022

Nilirad left a comment

Choose a reason for hiding this comment

mockersf left a comment

Choose a reason for hiding this comment

Nilirad left a comment

Choose a reason for hiding this comment

aevyrie commented Jul 19, 2022

alice-i-cecile commented Jul 19, 2022

bors bot commented Jul 19, 2022

mockersf commented Jul 19, 2022

[Merged by Bors] - Add helpers to send `Events` from `World` #5355

[Merged by Bors] - Add helpers to send `Events` from `World` #5355

aevyrie commented Jul 17, 2022 •

edited

Loading