Boss Bar API

crates/valence/src/tests.rs

@@ -280,8 +280,9 @@ impl_packet_list!(A, B, C, D, E, F, G, H, I);
 impl_packet_list!(A, B, C, D, E, F, G, H, I, J);
 impl_packet_list!(A, B, C, D, E, F, G, H, I, J, K);
 
+mod boss_bar;
 mod client;
 mod example;
 mod inventory;
 mod weather;
-mod world_border;
+mod world_border;

crates/valence/src/tests/boss_bar.rs

@@ -1,47 +1,178 @@
 use bevy_app::App;
 use bevy_ecs::entity::Entity;
-use valence_boss_bar::components::{BossBar, BossBarColor, BossBarDivision, BossBarFlags};
+use valence_boss_bar::components::{
+    BossBarBundle, BossBarColor, BossBarDivision, BossBarFlags, BossBarHealth, BossBarStyle,
+    BossBarTitle, BossBarViewers,
+};
+use valence_boss_bar::packet::BossBarS2c;
+use valence_core::despawn::Despawned;
 use valence_core::text::Text;
-use valence_instance::Instance;
 
-use super::{MockClientHelper, scenario_single_client, create_mock_client};
+use super::{scenario_single_client, MockClientHelper};
 
-/*#[test]
+#[test]
 fn test_intialize_on_join() {
     let mut app = App::new();
-    let (_, instance_ent) = prepare(&mut app);
+    let (client_ent, mut client_helper, instance_ent) = prepare(&mut app);
 
-    let (mut client, mut client_helper) = create_mock_client();
-    let client_ent = app.world.spawn(client).id();
+    // Fetch the boss bar component
+    let mut boss_bar = app.world.get_mut::<BossBarViewers>(instance_ent).unwrap();
+    // Add our mock client to the viewers list
+    boss_bar.current_viewers.push(client_ent);
 
-}*/
+    app.update();
+
+    // Check if a boss bar packet was sent
+    let frames = client_helper.collect_sent();
+    frames.assert_count::<BossBarS2c>(1);
+}
+
+#[test]
+fn test_despawn() {
+    let mut app = App::new();
+    let (client_ent, mut client_helper, instance_ent) = prepare(&mut app);
+
+    // Fetch the boss bar component
+    let mut boss_bar = app.world.get_mut::<BossBarViewers>(instance_ent).unwrap();
+    // Add our mock client to the viewers list
+    boss_bar.current_viewers.push(client_ent);
+
+    app.update();
+
+    // Despawn the boss bar
+    app.world.entity_mut(instance_ent).insert(Despawned);
+
+    app.update();
+
+    // Check if a boss bar packet was sent in addition to the ADD packet, which
+    // should be a Remove packet
+    let frames = client_helper.collect_sent();
+    frames.assert_count::<BossBarS2c>(2);
+}
+
+#[test]
+fn test_title_update() {
+    let mut app = App::new();
+    let (client_ent, mut client_helper, instance_ent) = prepare(&mut app);
+
+    // Fetch the boss bar component
+    let mut boss_bar = app.world.get_mut::<BossBarViewers>(instance_ent).unwrap();
+    // Add our mock client to the viewers list
+    boss_bar.current_viewers.push(client_ent);
+
+    app.update();
+
+    // Update the title
+    app.world
+        .entity_mut(instance_ent)
+        .insert(BossBarTitle(Text::text("Test 2")));
+
+    app.update();
+
+    // Check if a boss bar packet was sent in addition to the ADD packet, which
+    // should be an UpdateTitle packet
+    let frames = client_helper.collect_sent();
+    frames.assert_count::<BossBarS2c>(2);
+}
+
+#[test]
+fn test_health_update() {
+    let mut app = App::new();
+    let (client_ent, mut client_helper, instance_ent) = prepare(&mut app);
+
+    // Fetch the boss bar component
+    let mut boss_bar = app.world.get_mut::<BossBarViewers>(instance_ent).unwrap();
+    // Add our mock client to the viewers list
+    boss_bar.current_viewers.push(client_ent);
+
+    app.update();
+
+    // Update the health
+    app.world
+        .entity_mut(instance_ent)
+        .insert(BossBarHealth(0.5));
+
+    app.update();
+
+    // Check if a boss bar packet was sent in addition to the ADD packet, which
+    // should be an UpdateHealth packet
+    let frames = client_helper.collect_sent();
+    frames.assert_count::<BossBarS2c>(2);
+}
+
+#[test]
+fn test_style_update() {
+    let mut app = App::new();
+    let (client_ent, mut client_helper, instance_ent) = prepare(&mut app);
+
+    // Fetch the boss bar component
+    let mut boss_bar = app.world.get_mut::<BossBarViewers>(instance_ent).unwrap();
+    // Add our mock client to the viewers list
+    boss_bar.current_viewers.push(client_ent);
+
+    app.update();
+
+    // Update the style
+    app.world.entity_mut(instance_ent).insert(BossBarStyle {
+        color: BossBarColor::Red,
+        division: BossBarDivision::TenNotches,
+    });
+
+    app.update();
+
+    // Check if a boss bar packet was sent in addition to the ADD packet, which
+    // should be an UpdateStyle packet
+    let frames = client_helper.collect_sent();
+    frames.assert_count::<BossBarS2c>(2);
+}
+
+#[test]
+fn test_flags_update() {
+    let mut app = App::new();
+    let (client_ent, mut client_helper, instance_ent) = prepare(&mut app);
+
+    // Fetch the boss bar component
+    let mut boss_bar = app.world.get_mut::<BossBarViewers>(instance_ent).unwrap();
+    // Add our mock client to the viewers list
+    boss_bar.current_viewers.push(client_ent);
+
+    app.update();
+
+    // Update the flags
+    let mut new_flags = BossBarFlags::new();
+    new_flags.set_create_fog(true);
+    app.world.entity_mut(instance_ent).insert(new_flags);
+
+    app.update();
+
+    // Check if a boss bar packet was sent in addition to the ADD packet, which
+    // should be an UpdateFlags packet
+    let frames = client_helper.collect_sent();
+    frames.assert_count::<BossBarS2c>(2);
+}
 
-fn prepare(app: &mut App) -> (MockClientHelper, Entity) {
-    let (_, mut client_helper) = scenario_single_client(app);
+fn prepare(app: &mut App) -> (Entity, MockClientHelper, Entity) {
+    let (client_ent, mut client_helper) = scenario_single_client(app);
 
     // Process a tick to get past the "on join" logic.
     app.update();
     client_helper.clear_sent();
 
-    // Get the instance entity.
-    let instance_ent = app
+    // Insert a boss bar into the world
+    let boss_bar = app
         .world
-        .iter_entities()
-        .find(|e| e.contains::<Instance>())
-        .expect("could not find instance")
+        .spawn(BossBarBundle::new(
+            Text::text("Test"),
+            BossBarColor::Blue,
+            BossBarDivision::SixNotches,
+            BossBarFlags::new(),
+        ))
         .id();
 
-    // Insert a boss bar to the instance.
-    app.world.entity_mut(instance_ent).insert(
-            BossBar::new(Text::text(""),
-                BossBarColor::Red,
-                BossBarDivision::SixNotches,
-                BossBarFlags::new()));
-
     for _ in 0..2 {
         app.update();
     }
 
     client_helper.clear_sent();
-    (client_helper, instance_ent)
+    (client_ent, client_helper, boss_bar)
 }

crates/valence_boss_bar/src/components.rs

@@ -1,7 +1,10 @@
-use bevy_ecs::prelude::{Component, Entity, Bundle};
-use valence_core::{uuid::UniqueId, text::Text, protocol::{Encode, Decode}};
+use bevy_ecs::prelude::{Bundle, Component, Entity};
 use bitfield_struct::bitfield;
+use valence_core::protocol::{Decode, Encode};
+use valence_core::text::Text;
+use valence_core::uuid::UniqueId;
 
+/// The bundle of components that make up a boss bar.
 #[derive(Bundle)]
 pub struct BossBarBundle {
     pub id: UniqueId,
@@ -13,35 +16,40 @@ pub struct BossBarBundle {
 }
 
 impl BossBarBundle {
-
-    pub fn new(title: Text, color: BossBarColor, division: BossBarDivision, flags: BossBarFlags) -> BossBarBundle {
+    pub fn new(
+        title: Text,
+        color: BossBarColor,
+        division: BossBarDivision,
+        flags: BossBarFlags,
+    ) -> BossBarBundle {
         BossBarBundle {
             id: UniqueId::default(),
             title: BossBarTitle(title),
             health: BossBarHealth(1.0),
-            style: BossBarStyle {
-                color,
-                division,
-            },
+            style: BossBarStyle { color, division },
             flags,
-            viewers: BossBarViewers(Vec::new()),
+            viewers: BossBarViewers::default(),
         }
     }
-
 }
 
+/// The title of a boss bar.
 #[derive(Component, Clone)]
 pub struct BossBarTitle(pub Text);
 
+/// The health of a boss bar.
 #[derive(Component)]
 pub struct BossBarHealth(pub f32);
 
+/// The style of a boss bar. This includes the color and division of the boss
+/// bar.
 #[derive(Component)]
 pub struct BossBarStyle {
     pub color: BossBarColor,
     pub division: BossBarDivision,
 }
 
+/// The color of a boss bar.
 #[derive(Component, Copy, Clone, PartialEq, Eq, Debug, Encode, Decode)]
 pub enum BossBarColor {
     Pink,
@@ -53,6 +61,7 @@ pub enum BossBarColor {
     White,
 }
 
+/// The division of a boss bar.
 #[derive(Component, Copy, Clone, PartialEq, Eq, Debug, Encode, Decode)]
 pub enum BossBarDivision {
     NoDivision,
@@ -62,6 +71,7 @@ pub enum BossBarDivision {
     TwentyNotches,
 }
 
+/// The flags of a boss bar (darken sky, dragon bar, create fog).
 #[bitfield(u8)]
 #[derive(Component, PartialEq, Eq, Encode, Decode)]
 pub struct BossBarFlags {
@@ -72,5 +82,13 @@ pub struct BossBarFlags {
     _pad: u8,
 }
 
-#[derive(Component)]
-pub struct BossBarViewers(pub Vec<Entity>);
+/// The viewers of a boss bar.
+#[derive(Component, Default)]
+pub struct BossBarViewers {
+    /// The current viewers of the boss bar. It is the list that should be
+    /// updated.
+    pub current_viewers: Vec<Entity>,
+    /// The viewers of the last tick in order to determine which viewers have
+    /// been added and removed.
+    pub last_viewers: Vec<Entity>,
+}