Rename broadcast messages into shared messages

Less confusing. Closes #686.
No module rename yet, will be done in a separate commit
to make the diff readable.

Author: Shatur

CHANGELOG.md

@@ -9,7 +9,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Added
 
-- Broadcast messages and events via `BroadcastMessageAppExt` and `BroadcastEventAppExt`. Emitted as `Broadcast<M>` on both the sender and the receiver to allow shared logic for client-side prediction.
+- LocalOrRemote messages and events via `SharedMessageAppExt` and `SharedEventAppExt`. Emitted as `LocalOrRemote<M>` on both the sender and the receiver to allow shared logic for client-side prediction.
 - `iter_received` and `iter_sent` methods on `ClientMessages` and `ServerMessages` to inspect inbound and outbound messages on a channel without consuming them.
 
 ### Changed

src/client/message.rs

@@ -51,15 +51,15 @@ impl Plugin for ClientMessagePlugin {
             .build_state(app.world_mut())
             .build_system(send);
 
-        let broadcast_send_fn = (
+        let send_shared_fn = (
             FilteredResourcesMutParamBuilder::new(|builder| {
-                for message in registry.iter_all_broadcast() {
+                for message in registry.iter_all_shared() {
                     builder.add_write_by_id(message.messages_id());
                 }
             }),
             FilteredResourcesMutParamBuilder::new(|builder| {
-                for message in registry.iter_all_broadcast() {
-                    builder.add_write_by_id(message.broadcast_id());
+                for message in registry.iter_all_shared() {
+                    builder.add_write_by_id(message.shared_messages_id());
                 }
             }),
             ParamBuilder,
@@ -68,19 +68,19 @@ impl Plugin for ClientMessagePlugin {
             ParamBuilder,
         )
             .build_state(app.world_mut())
-            .build_system(broadcast_send);
+            .build_system(send_shared);
 
-        let broadcast_trigger_fn = (
+        let trigger_shared_fn = (
             FilteredResourcesMutParamBuilder::new(|builder| {
-                for event in registry.iter_broadcast_events() {
-                    builder.add_write_by_id(event.message().broadcast_id());
+                for event in registry.iter_shared_events() {
+                    builder.add_write_by_id(event.message().shared_messages_id());
                 }
             }),
             ParamBuilder,
             ParamBuilder,
         )
             .build_state(app.world_mut())
-            .build_system(broadcast_trigger);
+            .build_system(trigger_shared);
 
         let receive_builder = (
             FilteredResourcesMutParamBuilder::new(|builder| {
@@ -144,21 +144,21 @@ impl Plugin for ClientMessagePlugin {
             .build_state(app.world_mut())
             .build_system(send_locally);
 
-        let broadcast_send_locally_fn = (
+        let send_shared_locally_fn = (
             FilteredResourcesMutParamBuilder::new(|builder| {
-                for message in registry.iter_all_broadcast() {
-                    builder.add_write_by_id(message.broadcast_id());
+                for message in registry.iter_all_shared() {
+                    builder.add_write_by_id(message.shared_messages_id());
                 }
             }),
             FilteredResourcesMutParamBuilder::new(|builder| {
-                for message in registry.iter_all_broadcast() {
+                for message in registry.iter_all_shared() {
                     builder.add_write_by_id(message.messages_id());
                 }
             }),
             ParamBuilder,
         )
             .build_state(app.world_mut())
-            .build_system(broadcast_send_locally);
+            .build_system(send_shared_locally);
 
         let reset_fn = (
             FilteredResourcesMutParamBuilder::new(|builder| {
@@ -172,7 +172,7 @@ impl Plugin for ClientMessagePlugin {
                 }
             }),
             FilteredResourcesMutParamBuilder::new(|builder| {
-                for message in registry.iter_all_broadcast() {
+                for message in registry.iter_all_shared() {
                     builder.add_write_by_id(message.messages_id());
                 }
             }),
@@ -206,10 +206,10 @@ impl Plugin for ClientMessagePlugin {
             .add_systems(
                 PostUpdate,
                 (
-                    (send_fn, broadcast_send_fn).run_if(in_state(ClientState::Connected)),
-                    (send_locally_fn, broadcast_send_locally_fn)
+                    (send_fn, send_shared_fn).run_if(in_state(ClientState::Connected)),
+                    (send_locally_fn, send_shared_locally_fn)
                         .run_if(in_state(ClientState::Disconnected)),
-                    broadcast_trigger_fn,
+                    trigger_shared_fn,
                 )
                     .chain()
                     .in_set(ClientSystems::Send),
@@ -251,9 +251,9 @@ fn send(
     }
 }
 
-fn broadcast_send(
+fn send_shared(
     mut messages: FilteredResourcesMut,
-    mut broadcasts: FilteredResourcesMut,
+    mut shared_messages: FilteredResourcesMut,
     mut client_messages: ResMut<ClientMessages>,
     type_registry: Res<AppTypeRegistry>,
     entity_map: Res<ServerEntityMap>,
@@ -265,20 +265,20 @@ fn broadcast_send(
         invalid_entities: Vec::new(),
     };
 
-    for message in registry.iter_all_broadcast() {
+    for message in registry.iter_all_shared() {
         let messages = messages
             .get_mut_by_id(message.messages_id())
             .expect("messages resource should be accessible");
-        let broadcasts = broadcasts
-            .get_mut_by_id(message.broadcast_id())
-            .expect("broadcast messages resource should be accessible");
+        let shared_messages = shared_messages
+            .get_mut_by_id(message.shared_messages_id())
+            .expect("shared messages resource should be accessible");
 
         // SAFETY: passed pointers were obtained using this message data.
         unsafe {
             message.send(
                 &mut ctx,
                 messages.into_inner(),
-                broadcasts.into_inner(),
+                shared_messages.into_inner(),
                 &mut client_messages,
             );
         }
@@ -334,17 +334,17 @@ fn trigger(
     }
 }
 
-fn broadcast_trigger(
-    mut broadcasts: FilteredResourcesMut,
+fn trigger_shared(
+    mut shared_messages: FilteredResourcesMut,
     mut commands: Commands,
     registry: Res<RemoteMessageRegistry>,
 ) {
-    for event in registry.iter_broadcast_events() {
-        let broadcasts = broadcasts
-            .get_mut_by_id(event.message().broadcast_id())
-            .expect("broadcast messages resource should be accessible");
+    for event in registry.iter_shared_events() {
+        let shared_messages = shared_messages
+            .get_mut_by_id(event.message().shared_messages_id())
+            .expect("shared messages resource should be accessible");
         // SAFETY: passed pointer was obtained using this event data.
-        unsafe { event.trigger(&mut commands, broadcasts.into_inner()) };
+        unsafe { event.trigger(&mut commands, shared_messages.into_inner()) };
     }
 }
 
@@ -366,28 +366,28 @@ fn send_locally(
     }
 }
 
-fn broadcast_send_locally(
-    mut broadcasts: FilteredResourcesMut,
+fn send_shared_locally(
+    mut shared_messages: FilteredResourcesMut,
     mut messages: FilteredResourcesMut,
     registry: Res<RemoteMessageRegistry>,
 ) {
-    for message in registry.iter_all_broadcast() {
-        let broadcasts = broadcasts
-            .get_mut_by_id(message.broadcast_id())
-            .expect("broadcast messages resource should be accessible");
+    for message in registry.iter_all_shared() {
+        let shared_messages = shared_messages
+            .get_mut_by_id(message.shared_messages_id())
+            .expect("shared messages resource should be accessible");
         let messages = messages
             .get_mut_by_id(message.messages_id())
             .expect("messages resource should be accessible");
 
         // SAFETY: passed pointers were obtained using this message data.
-        unsafe { message.send_locally(broadcasts.into_inner(), messages.into_inner()) };
+        unsafe { message.send_locally(shared_messages.into_inner(), messages.into_inner()) };
     }
 }
 
 fn reset(
     mut messages: FilteredResourcesMut,
     mut queues: FilteredResourcesMut,
-    mut broadcast_messages: FilteredResourcesMut,
+    mut shared_messages: FilteredResourcesMut,
     registry: Res<RemoteMessageRegistry>,
 ) {
     for message in registry.iter_all_client() {
@@ -408,12 +408,12 @@ fn reset(
         unsafe { messages.reset(queue.into_inner()) };
     }
 
-    for message in registry.iter_all_broadcast() {
-        let messages = broadcast_messages
+    for message in registry.iter_all_shared() {
+        let shared_messages = shared_messages
             .get_mut_by_id(message.messages_id())
-            .expect("broadcast messages resource should be accessible");
+            .expect("shared messages resource should be accessible");
 
         // SAFETY: passed pointer was obtained using this message data.
-        unsafe { message.reset(messages.into_inner()) };
+        unsafe { message.reset(shared_messages.into_inner()) };
     }
 }

src/lib.rs

@@ -354,29 +354,29 @@ Similar to messages, serialization can also be customized with [`ClientEventAppE
 
 If you need to react to the same message on both the client and the server (for example,
 to share logic between client-side prediction and authoritative server processing), use
-[`BroadcastMessageAppExt::add_broadcast_message`] or
-[`BroadcastEventAppExt::add_broadcast_event`]. The message is emitted as [`Broadcast<M>`]
-on both sides, with the [`Broadcaster`] field indicating its origin.
+[`SharedMessageAppExt::add_shared_message`] or
+[`SharedEventAppExt::add_shared_event`]. The message is emitted as [`LocalOrRemote<M>`]
+on both sides, with the [`Sender`] field indicating its origin.
 
 ```
 # use bevy::{prelude::*, state::app::StatesPlugin};
 # use bevy_replicon::prelude::*;
 # use serde::{Deserialize, Serialize};
 # let mut app = App::new();
 # app.add_plugins((StatesPlugin, RepliconPlugins));
-app.add_broadcast_event::<Attack>(Channel::Ordered)
+app.add_shared_event::<Attack>(Channel::Ordered)
     .add_observer(on_attack);
 
-fn on_attack(on: On<Broadcast<Attack>>) {
-    info!("attack from `{:?}`", on.broadcaster);
+fn on_attack(attack: On<LocalOrRemote<Attack>>) {
+    info!("attack from `{:?}`", attack.sender);
 }
 
 #[derive(Event, Deserialize, Serialize)]
 struct Attack;
 ```
 
-Similar to regular client messages, we also provide [`BroadcastEventAppExt::add_mapped_broadcast_event`].
-and [`BroadcastEventAppExt::add_broadcast_event_with`].
+Similar to regular client messages, we also provide [`SharedEventAppExt::add_mapped_shared_event`].
+and [`SharedEventAppExt::add_shared_event_with`].
 
 ### From server to client
 
@@ -731,8 +731,8 @@ pub mod prelude {
             },
             client_id::ClientId,
             message::{
-                broadcast_event::{BroadcastEventAppExt, BroadcastTriggerExt},
-                broadcast_message::{Broadcast, BroadcastMessageAppExt, Broadcaster},
+                broadcast_event::{SharedEventAppExt, SharedTriggerExt},
+                broadcast_message::{LocalOrRemote, Sender, SharedMessageAppExt},
                 client_event::{ClientEventAppExt, ClientTriggerExt},
                 client_message::{ClientMessageAppExt, FromClient},
                 server_event::{ServerEventAppExt, ServerTriggerExt},

src/server/message.rs

@@ -61,18 +61,18 @@ impl Plugin for ServerMessagePlugin {
             .build_state(app.world_mut())
             .build_system(receive);
 
-        let broadcast_receive_fn = (
+        let receive_shared_fn = (
             FilteredResourcesMutParamBuilder::new(|builder| {
-                for message in registry.iter_all_broadcast() {
-                    builder.add_write_by_id(message.broadcast_id());
+                for message in registry.iter_all_shared() {
+                    builder.add_write_by_id(message.shared_messages_id());
                 }
             }),
             ParamBuilder,
             ParamBuilder,
             ParamBuilder,
         )
             .build_state(app.world_mut())
-            .build_system(broadcast_receive);
+            .build_system(receive_shared);
 
         let trigger_fn = (
             FilteredResourcesMutParamBuilder::new(|builder| {
@@ -86,17 +86,17 @@ impl Plugin for ServerMessagePlugin {
             .build_state(app.world_mut())
             .build_system(trigger);
 
-        let broadcast_trigger_fn = (
+        let trigger_shared_fn = (
             FilteredResourcesMutParamBuilder::new(|builder| {
-                for event in registry.iter_broadcast_events() {
-                    builder.add_write_by_id(event.message().broadcast_id());
+                for event in registry.iter_shared_events() {
+                    builder.add_write_by_id(event.message().shared_messages_id());
                 }
             }),
             ParamBuilder,
             ParamBuilder,
         )
             .build_state(app.world_mut())
-            .build_system(broadcast_trigger);
+            .build_system(trigger_shared);
 
         let send_locally_fn = (
             FilteredResourcesMutParamBuilder::new(|builder| {
@@ -118,10 +118,10 @@ impl Plugin for ServerMessagePlugin {
             .add_systems(
                 PreUpdate,
                 (
-                    (receive_fn, broadcast_receive_fn).run_if(in_state(ServerState::Running)),
+                    (receive_fn, receive_shared_fn).run_if(in_state(ServerState::Running)),
                     (
                         trigger_fn.run_if(in_state(ClientState::Disconnected)),
-                        broadcast_trigger_fn,
+                        trigger_shared_fn,
                     ),
                 )
                     .chain()
@@ -204,8 +204,8 @@ fn receive(
     }
 }
 
-fn broadcast_receive(
-    mut broadcasts: FilteredResourcesMut,
+fn receive_shared(
+    mut shared_messages: FilteredResourcesMut,
     mut server_messages: ResMut<ServerMessages>,
     type_registry: Res<AppTypeRegistry>,
     message_registry: Res<RemoteMessageRegistry>,
@@ -214,13 +214,13 @@ fn broadcast_receive(
         type_registry: &type_registry,
     };
 
-    for message in message_registry.iter_all_broadcast() {
-        let broadcasts = broadcasts
-            .get_mut_by_id(message.broadcast_id())
-            .expect("broadcast messages resource should be accessible");
+    for message in message_registry.iter_all_shared() {
+        let shared_messages = shared_messages
+            .get_mut_by_id(message.shared_messages_id())
+            .expect("shared messages resource should be accessible");
 
         // SAFETY: passed pointer was obtained using this message data.
-        unsafe { message.receive(&mut ctx, broadcasts.into_inner(), &mut server_messages) };
+        unsafe { message.receive(&mut ctx, shared_messages.into_inner(), &mut server_messages) };
     }
 }
 
@@ -238,17 +238,17 @@ fn trigger(
     }
 }
 
-fn broadcast_trigger(
-    mut broadcasts: FilteredResourcesMut,
+fn trigger_shared(
+    mut shared_messages: FilteredResourcesMut,
     mut commands: Commands,
     registry: Res<RemoteMessageRegistry>,
 ) {
-    for event in registry.iter_broadcast_events() {
-        let broadcasts = broadcasts
-            .get_mut_by_id(event.message().broadcast_id())
-            .expect("broadcast messages resource should be accessible");
+    for event in registry.iter_shared_events() {
+        let shared_messages = shared_messages
+            .get_mut_by_id(event.message().shared_messages_id())
+            .expect("shared messages resource should be accessible");
         // SAFETY: passed pointer was obtained using this event data.
-        unsafe { event.trigger(&mut commands, broadcasts.into_inner()) };
+        unsafe { event.trigger(&mut commands, shared_messages.into_inner()) };
     }
 }