Skip to content

Commit 8578ec2

Browse files
committed
Remove "together" references
1 parent f4ad1df commit 8578ec2

3 files changed

Lines changed: 9 additions & 8 deletions

File tree

src/server/replication_messages/mutations.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,10 +22,10 @@ use crate::shared::{
2222
/// Can be packed into messages using [`Self::send`].
2323
#[derive(Default, Component)]
2424
pub(crate) struct Mutations {
25-
/// Entities that are related to each other and should be replicated together.
25+
/// Entities that are related to each other and should be replicated in sync.
2626
///
2727
/// Like [`Self::standalone`], but grouped into arrays based on their relation graph indices.
28-
/// These entities are guaranteed to replicate together.
28+
/// These entities are guaranteed to be included in a single message.
2929
related: Vec<Vec<EntityMutations>>,
3030

3131
/// Component mutations that happened in this tick.

src/shared/backend/replicon_channels.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -96,8 +96,8 @@ impl RepliconChannels {
9696
/// since the last acknowledgment. We also include a minimum required tick - the tick on which the last update
9797
/// message was sent. Messages will be buffered until an update message for this tick is received. Mutations
9898
/// are split into packet-size messages to allow applying them partially without waiting for all parts of the message.
99-
/// We guarantee that all mutations for a single entity arrive together, even if they are larger than the packet size.
100-
/// You can also ensure that mutations for specific entities arrive together by using
99+
/// We guarantee that all mutations for a single entity arrive won't be split across messages, even if they are larger
100+
/// than the packet size. You can also ensure that mutations for specific entities arrive in sync by using
101101
/// [`SyncRelatedAppExt::sync_related_entities`](crate::shared::replication::related_entities::SyncRelatedAppExt::sync_related_entities).
102102
///
103103
/// Server events also have minimum required tick. For details, see the documentation on

src/shared/replication/related_entities.rs

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,9 @@ pub trait SyncRelatedAppExt {
2020
/// Ensures that entities related by `C` are replicated in sync.
2121
///
2222
/// By default, we split mutations across multiple messages to apply them independently.
23-
/// We guarantee that all mutations for a single entity arrive together, but mutations for
24-
/// separate entities may be received independently if they arrive in different messages.
23+
/// We guarantee that all mutations for a single entity won't be split across messages,
24+
/// but mutations for separate entities may be received independently if they arrive in
25+
/// different messages.
2526
///
2627
/// Calling this method guarantees that all mutations related by `C` are included in
2728
/// a single message.
@@ -36,7 +37,7 @@ pub trait SyncRelatedAppExt {
3637
/// app.sync_related_entities::<ChildOf>();
3738
///
3839
/// // Changes to any replicated components on these
39-
/// // entities will be replicated together.
40+
/// // entities will be replicated in sync.
4041
/// app.world_mut().spawn((
4142
/// Replicated,
4243
/// Transform::default(),
@@ -65,7 +66,7 @@ impl SyncRelatedAppExt for App {
6566
/// Each graph represented by index.
6667
#[derive(Resource, Default)]
6768
pub(crate) struct RelatedEntities {
68-
/// Global graph of of all relationship types marked for replication together.
69+
/// Global graph of all relationship types marked for replication in sync.
6970
///
7071
/// We use a stable graph to avoid indices invalidation since we map them to entities and
7172
/// can't use graphmap because it doesn't support parallel connections (needed when

0 commit comments

Comments
 (0)