Accept client entity in is_visible

Useful to express filters like `Owner`.

Author: Shatur

CHANGELOG.md

@@ -16,8 +16,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Changed
 
-- In `VisibilityFilter::is_visible` the second argument is now wrapped in an `Option`, and the arguments have been swapped: `self` is now the entity component, and the client component is the second argument.
-- `VisibilityFilter` now has a `ClientComponent` associated type, which allows using a different component for client entities. Set it to `Self` to preserve the old behavior.
+- `VisibilityFilter` now allows expressing more complex rules:
+  - A new `ClientComponent` associated type allows specifying a different component for client entities. Use `Self` to preserve the previous behavior.
+  - In `is_visible`, `self` now refers to the entity component, and the client component is passed into the function.
+  - The passed component is now wrapped in an `Option` to allow customizing behavior when the component on the client is missing.
+  - `is_visible` now accepts the client entity.
 - `AuthorizedClient` and `ConnectedClient` now immutable.
 - `ClientStats` now represents only current client statistics. Use the `ConnectedClientStats` component for connected client statistics on the server.
 - `ConditionerConfig` now represents configuration only for a connected client on the server. Use the `GlobalConditionerConfig` resource for global server or client configuration.

example_backend/examples/authoritative_rts.rs

@@ -750,7 +750,11 @@ impl VisibilityFilter for Team {
     type ClientComponent = Self;
     type Scope = SingleComponent<Command>;
 
-    fn is_visible(&self, client_component: Option<&Self::ClientComponent>) -> bool {
+    fn is_visible(
+        &self,
+        _client: Entity,
+        client_component: Option<&Self::ClientComponent>,
+    ) -> bool {
         client_component.is_some_and(|c| self == c)
     }
 }

src/server/visibility.rs

@@ -80,7 +80,7 @@ pub trait AppVisibilityExt {
         type ClientComponent = Self;
         type Scope = Entity;
 
-        fn is_visible(&self, client_component: Option<&Self::ClientComponent>) -> bool {
+        fn is_visible(&self, _client: Entity, client_component: Option<&Self::ClientComponent>) -> bool {
             client_component.is_some_and(|c| self == c)
         }
     }
@@ -116,7 +116,7 @@ fn update_for_new_clients<F: VisibilityFilter>(
     if let Ok(mut visibility) = clients.get_mut(insert.entity) {
         let bit = registry.bit::<F>();
         for (entity, component) in &entities {
-            let visible = component.is_visible(None);
+            let visible = component.is_visible(insert.entity, None);
             debug!(
                 "evaluating missing `{}` for new client `{}` for entity `{entity}` to `{visible}`",
                 ShortName::of::<F>(),
@@ -136,7 +136,7 @@ fn on_insert<F: VisibilityFilter>(
     let bit = registry.bit::<F>();
     if let Ok((client, client_component, mut visibility)) = clients.get_mut(insert.entity) {
         for (entity, component) in &entities {
-            let visible = component.is_visible(client_component);
+            let visible = component.is_visible(client, client_component);
             debug!(
                 "evaluating inserted `{}` to client `{client}` for entity `{entity}` to `{visible}`",
                 ShortName::of::<F>(),
@@ -146,7 +146,7 @@ fn on_insert<F: VisibilityFilter>(
     } else {
         let (entity, component) = entities.get(insert.entity).unwrap();
         for (client, client_component, mut visibility) in &mut clients {
-            let visible = component.is_visible(client_component);
+            let visible = component.is_visible(client, client_component);
             debug!(
                 "evaluating inserted `{}` to entity `{entity}` for client `{client}` to `{visible}`",
                 ShortName::of::<F>(),
@@ -190,7 +190,7 @@ fn on_client_remove<F: VisibilityFilter>(
 
     let bit = registry.bit::<F>();
     for (entity, component) in &entities {
-        let visible = component.is_visible(None);
+        let visible = component.is_visible(remove.entity, None);
         debug!(
             "evaluating removed `{}` from client `{}` for entity `{entity}` to `{visible}`",
             ShortName::of::<F>(),
@@ -226,7 +226,7 @@ pub trait VisibilityFilter: Component<Mutability = Immutable> {
         type ClientComponent = Moderator;
         type Scope = Entity;
 
-        fn is_visible(&self, client_component: Option<&Self::ClientComponent>) -> bool {
+        fn is_visible(&self, _client: Entity, client_component: Option<&Self::ClientComponent>) -> bool {
             // Only moderators can see entities with sensitive information.
             client_component.is_some()
         }
@@ -246,7 +246,7 @@ pub trait VisibilityFilter: Component<Mutability = Immutable> {
         type ClientComponent = Self;
         type Scope = Entity;
 
-        fn is_visible(&self, client_component: Option<&Self::ClientComponent>) -> bool {
+        fn is_visible(&self, _client: Entity, client_component: Option<&Self::ClientComponent>) -> bool {
             // Visible only if the client also has `SpectatorOnly`.
             client_component.is_some()
         }
@@ -276,7 +276,7 @@ pub trait VisibilityFilter: Component<Mutability = Immutable> {
     ///     type ClientComponent = Self;
     ///     type Scope = Entity;
     ///
-    ///     fn is_visible(&self, client_component: Option<&Self::ClientComponent>) -> bool {
+    ///     fn is_visible(&self, _client: Entity, client_component: Option<&Self::ClientComponent>) -> bool {
     ///         client_component.is_some_and(|c| self == c)
     ///     }
     /// }
@@ -295,7 +295,7 @@ pub trait VisibilityFilter: Component<Mutability = Immutable> {
     ///     type ClientComponent = Self;
     ///     type Scope = SingleComponent<Health>;
     ///
-    ///     fn is_visible(&self, client_component: Option<&Self::ClientComponent>) -> bool {
+    ///     fn is_visible(&self, _client: Entity, client_component: Option<&Self::ClientComponent>) -> bool {
     ///         client_component.is_some_and(|c| self == c)
     ///     }
     /// }
@@ -317,7 +317,7 @@ pub trait VisibilityFilter: Component<Mutability = Immutable> {
     ///     type ClientComponent = Self;
     ///     type Scope = (Health, Stats);
     ///
-    ///     fn is_visible(&self, client_component: Option<&Self::ClientComponent>) -> bool {
+    ///     fn is_visible(&self, _client: Entity, client_component: Option<&Self::ClientComponent>) -> bool {
     ///         client_component.is_some_and(|c| self == c)
     ///     }
     /// }
@@ -352,7 +352,7 @@ pub trait VisibilityFilter: Component<Mutability = Immutable> {
         type ClientComponent = Self;
         type Scope = Entity;
 
-        fn is_visible(&self, client_component: Option<&Self::ClientComponent>) -> bool {
+        fn is_visible(&self, _client: Entity, client_component: Option<&Self::ClientComponent>) -> bool {
             client_component.is_some()
         }
     }
@@ -375,7 +375,7 @@ pub trait VisibilityFilter: Component<Mutability = Immutable> {
         type ClientComponent = Unit;
         type Scope = Entity;
 
-        fn is_visible(&self, client_component: Option<&Self::ClientComponent>) -> bool {
+        fn is_visible(&self, _client: Entity, client_component: Option<&Self::ClientComponent>) -> bool {
             // Blind clients cannot see units.
             client_component.is_none()
         }
@@ -395,7 +395,7 @@ pub trait VisibilityFilter: Component<Mutability = Immutable> {
         type ClientComponent = Self;
         type Scope = Entity;
 
-        fn is_visible(&self, client_component: Option<&Self::ClientComponent>) -> bool {
+        fn is_visible(&self, _client: Entity, client_component: Option<&Self::ClientComponent>) -> bool {
             // Visible if the client belongs to the same team.
             client_component.is_some_and(|c| self == c)
         }
@@ -424,13 +424,32 @@ pub trait VisibilityFilter: Component<Mutability = Immutable> {
         type ClientComponent = Self;
         type Scope = Entity;
 
-        fn is_visible(&self, client_component: Option<&Self::ClientComponent>) -> bool {
+        fn is_visible(&self, _client: Entity, client_component: Option<&Self::ClientComponent>) -> bool {
             client_component.is_some_and(|&c| self.contains(c))
         }
     }
     ```
+
+    Visible if the component references the client entity:
+
+    ```
+    # use bevy::prelude::*;
+    # use bevy_replicon::prelude::*;
+    #[derive(Component, PartialEq)]
+    #[component(immutable)]
+    struct Owner(Entity);
+
+    impl VisibilityFilter for Owner {
+        type ClientComponent = AuthorizedClient; // All clients authorized for replication have this component.
+        type Scope = Entity;
+
+        fn is_visible(&self, client: Entity, _client_component: Option<&Self::ClientComponent>) -> bool {
+            self.0 == client
+        }
+    }
+    ```
     */
-    fn is_visible(&self, client_component: Option<&Self::ClientComponent>) -> bool;
+    fn is_visible(&self, client: Entity, client_component: Option<&Self::ClientComponent>) -> bool;
 }
 
 /// Associates the type with a visibility scope.
@@ -642,7 +661,11 @@ mod tests {
         type ClientComponent = Self;
         type Scope = Entity;
 
-        fn is_visible(&self, client_component: Option<&Self::ClientComponent>) -> bool {
+        fn is_visible(
+            &self,
+            _client: Entity,
+            client_component: Option<&Self::ClientComponent>,
+        ) -> bool {
             client_component.is_some()
         }
     }
@@ -655,7 +678,11 @@ mod tests {
         type ClientComponent = ClientFilter;
         type Scope = Entity;
 
-        fn is_visible(&self, client_component: Option<&Self::ClientComponent>) -> bool {
+        fn is_visible(
+            &self,
+            _client: Entity,
+            client_component: Option<&Self::ClientComponent>,
+        ) -> bool {
             client_component.is_some()
         }
     }

src/server/visibility/registry.rs

@@ -223,7 +223,11 @@ mod tests {
         type ClientComponent = Self;
         type Scope = Entity;
 
-        fn is_visible(&self, client_component: Option<&Self::ClientComponent>) -> bool {
+        fn is_visible(
+            &self,
+            _client: Entity,
+            client_component: Option<&Self::ClientComponent>,
+        ) -> bool {
             client_component.is_some()
         }
     }
@@ -236,7 +240,11 @@ mod tests {
         type ClientComponent = Self;
         type Scope = SingleComponent<A>;
 
-        fn is_visible(&self, client_component: Option<&Self::ClientComponent>) -> bool {
+        fn is_visible(
+            &self,
+            _client: Entity,
+            client_component: Option<&Self::ClientComponent>,
+        ) -> bool {
             client_component.is_some()
         }
     }
@@ -249,7 +257,11 @@ mod tests {
         type ClientComponent = Self;
         type Scope = (A, B);
 
-        fn is_visible(&self, client_component: Option<&Self::ClientComponent>) -> bool {
+        fn is_visible(
+            &self,
+            _client: Entity,
+            client_component: Option<&Self::ClientComponent>,
+        ) -> bool {
             client_component.is_some()
         }
     }

tests/despawn.rs

@@ -328,7 +328,11 @@ impl VisibilityFilter for EntityVisibility {
     type ClientComponent = Self;
     type Scope = Entity;
 
-    fn is_visible(&self, client_component: Option<&Self::ClientComponent>) -> bool {
+    fn is_visible(
+        &self,
+        _client: Entity,
+        client_component: Option<&Self::ClientComponent>,
+    ) -> bool {
         client_component.is_some()
     }
 }
@@ -341,7 +345,11 @@ impl VisibilityFilter for ComponentVisibility {
     type ClientComponent = Self;
     type Scope = SingleComponent<TestComponent>;
 
-    fn is_visible(&self, client_component: Option<&Self::ClientComponent>) -> bool {
+    fn is_visible(
+        &self,
+        _client: Entity,
+        client_component: Option<&Self::ClientComponent>,
+    ) -> bool {
         client_component.is_some()
     }
 }

tests/insertion.rs

@@ -802,7 +802,11 @@ impl VisibilityFilter for EntityVisibility {
     type ClientComponent = Self;
     type Scope = Entity;
 
-    fn is_visible(&self, client_component: Option<&Self::ClientComponent>) -> bool {
+    fn is_visible(
+        &self,
+        _client: Entity,
+        client_component: Option<&Self::ClientComponent>,
+    ) -> bool {
         client_component.is_some()
     }
 }
@@ -815,7 +819,11 @@ impl VisibilityFilter for ComponentVisibility {
     type ClientComponent = Self;
     type Scope = SingleComponent<A>;
 
-    fn is_visible(&self, client_component: Option<&Self::ClientComponent>) -> bool {
+    fn is_visible(
+        &self,
+        _client: Entity,
+        client_component: Option<&Self::ClientComponent>,
+    ) -> bool {
         client_component.is_some()
     }
 }

tests/removal.rs

@@ -640,7 +640,11 @@ impl VisibilityFilter for EntityVisibility {
     type ClientComponent = Self;
     type Scope = Entity;
 
-    fn is_visible(&self, client_component: Option<&Self::ClientComponent>) -> bool {
+    fn is_visible(
+        &self,
+        _client: Entity,
+        client_component: Option<&Self::ClientComponent>,
+    ) -> bool {
         client_component.is_some()
     }
 }
@@ -653,7 +657,11 @@ impl VisibilityFilter for ComponentVisibility {
     type ClientComponent = Self;
     type Scope = SingleComponent<A>;
 
-    fn is_visible(&self, client_component: Option<&Self::ClientComponent>) -> bool {
+    fn is_visible(
+        &self,
+        _client: Entity,
+        client_component: Option<&Self::ClientComponent>,
+    ) -> bool {
         client_component.is_some()
     }
 }

tests/spawn.rs

@@ -583,7 +583,11 @@ impl VisibilityFilter for EntityVisibility {
     type ClientComponent = Self;
     type Scope = Entity;
 
-    fn is_visible(&self, client_component: Option<&Self::ClientComponent>) -> bool {
+    fn is_visible(
+        &self,
+        _client: Entity,
+        client_component: Option<&Self::ClientComponent>,
+    ) -> bool {
         client_component.is_some()
     }
 }