Skip to content

refactor held item into a new component #356

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
rj00a merged 1 commit into from
Jun 7, 2023
Merged

refactor held item into a new component #356

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions crates/valence/examples/building.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
#![allow(clippy::type_complexity)]

use valence::inventory::ClientInventoryState;
use valence::inventory::HeldItem;
use valence::prelude::*;
use valence_client::interact_block::InteractBlockEvent;

Expand Down Expand Up @@ -109,22 +109,22 @@ fn digging_survival_mode(
}

fn place_blocks(
mut clients: Query<(&mut Inventory, &GameMode, &ClientInventoryState)>,
mut clients: Query<(&mut Inventory, &GameMode, &HeldItem)>,
mut instances: Query<&mut Instance>,
mut events: EventReader<InteractBlockEvent>,
) {
let mut instance = instances.single_mut();

for event in events.iter() {
let Ok((mut inventory, game_mode, inv_state)) = clients.get_mut(event.client) else {
let Ok((mut inventory, game_mode, held)) = clients.get_mut(event.client) else {
continue;
};
if event.hand != Hand::Main {
continue;
}

// get the held item
let slot_id = inv_state.held_item_slot();
let slot_id = held.slot();
let Some(stack) = inventory.slot(slot_id) else {
// no item in the slot
continue;
Expand Down
16 changes: 8 additions & 8 deletions crates/valence/src/tests/inventory.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@ use valence_inventory::packet::{
OpenScreenS2c, ScreenHandlerSlotUpdateS2c, SlotChange, UpdateSelectedSlotC2s,
};
use valence_inventory::{
convert_to_player_slot_id, ClientInventoryState, CursorItem, DropItemStack, Inventory,
InventoryKind, OpenInventory,
convert_to_player_slot_id, ClientInventoryState, CursorItem, DropItemStack, HeldItem,
Inventory, InventoryKind, OpenInventory,
};

use super::*;
Expand Down Expand Up @@ -474,12 +474,12 @@ fn test_should_handle_set_held_item() {
app.update();

// Make assertions
let inv_state = app
let held = app
.world
.get::<ClientInventoryState>(client_ent)
.get::<HeldItem>(client_ent)
.expect("could not find client");

assert_eq!(inv_state.held_item_slot(), 40);
assert_eq!(held.slot(), 40);
}

#[test]
Expand Down Expand Up @@ -602,11 +602,11 @@ mod dropping_items {
app.update();

// Make assertions
let inv_state = app
let held = app
.world
.get::<ClientInventoryState>(client_ent)
.get::<HeldItem>(client_ent)
.expect("could not find client");
assert_eq!(inv_state.held_item_slot(), 36);
assert_eq!(held.slot(), 36);
let inventory = app
.world
.get::<Inventory>(client_ent)
Expand Down
54 changes: 33 additions & 21 deletions crates/valence_inventory/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -337,15 +337,9 @@ pub struct ClientInventoryState {
/// on the `CursorItem` component to make maintaining accurate change
/// detection for end users easier.
client_updated_cursor_item: bool,
// TODO: make this a separate modifiable component.
held_item_slot: u16,
}

impl ClientInventoryState {
pub fn held_item_slot(&self) -> u16 {
self.held_item_slot
}

#[doc(hidden)]
pub fn window_id(&self) -> u8 {
self.window_id
Expand All @@ -357,6 +351,20 @@ impl ClientInventoryState {
}
}

/// Indicates which hotbar slot the player is currently holding.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Component)]
pub struct HeldItem {
held_item_slot: u16,
}

impl HeldItem {
/// The slot ID of the currently held item, in the range 36-44 inclusive.
/// This value is safe to use on the player's inventory directly.
pub fn slot(&self) -> u16 {
self.held_item_slot
}
}

/// The item stack that the client thinks it's holding under the mouse
/// cursor.
#[derive(Component, Clone, PartialEq, Default, Debug)]
Expand Down Expand Up @@ -533,6 +541,8 @@ fn init_new_client_inventories(clients: Query<Entity, Added<Client>>, mut comman
state_id: Wrapping(0),
slots_changed: 0,
client_updated_cursor_item: false,
},
HeldItem {
// First slot of the hotbar.
held_item_slot: 36,
},
Expand Down Expand Up @@ -1039,43 +1049,42 @@ fn handle_click_slot(

fn handle_player_actions(
mut packets: EventReader<PacketEvent>,
mut clients: Query<(&mut Inventory, &mut ClientInventoryState)>,
mut clients: Query<(&mut Inventory, &mut ClientInventoryState, &HeldItem)>,
mut drop_item_stack_events: EventWriter<DropItemStack>,
) {
for packet in packets.iter() {
if let Some(pkt) = packet.decode::<PlayerActionC2s>() {
match pkt.action {
PlayerAction::DropAllItems => {
if let Ok((mut inv, mut inv_state)) = clients.get_mut(packet.client) {
if let Some(stack) = inv.replace_slot(inv_state.held_item_slot, None) {
inv_state.slots_changed |= 1 << inv_state.held_item_slot;
if let Ok((mut inv, mut inv_state, &held)) = clients.get_mut(packet.client) {
if let Some(stack) = inv.replace_slot(held.slot(), None) {
inv_state.slots_changed |= 1 << held.slot();

drop_item_stack_events.send(DropItemStack {
client: packet.client,
from_slot: Some(inv_state.held_item_slot),
from_slot: Some(held.slot()),
stack,
});
}
}
}
PlayerAction::DropItem => {
if let Ok((mut inv, mut inv_state)) = clients.get_mut(packet.client) {
if let Some(mut stack) = inv.replace_slot(inv_state.held_item_slot(), None)
{
if let Ok((mut inv, mut inv_state, held)) = clients.get_mut(packet.client) {
if let Some(mut stack) = inv.replace_slot(held.slot(), None) {
if stack.count() > 1 {
inv.set_slot(
inv_state.held_item_slot(),
held.slot(),
stack.clone().with_count(stack.count() - 1),
);

stack.set_count(1);
}

inv_state.slots_changed |= 1 << inv_state.held_item_slot();
inv_state.slots_changed |= 1 << held.slot();

drop_item_stack_events.send(DropItemStack {
client: packet.client,
from_slot: Some(inv_state.held_item_slot()),
from_slot: Some(held.slot()),
stack,
})
}
Expand Down Expand Up @@ -1169,14 +1178,17 @@ pub struct UpdateSelectedSlot {

fn handle_update_selected_slot(
mut packets: EventReader<PacketEvent>,
mut clients: Query<&mut ClientInventoryState>,
mut clients: Query<&mut HeldItem>,
mut events: EventWriter<UpdateSelectedSlot>,
) {
for packet in packets.iter() {
if let Some(pkt) = packet.decode::<UpdateSelectedSlotC2s>() {
if let Ok(mut inv_state) = clients.get_mut(packet.client) {
// TODO: validate this.
inv_state.held_item_slot = convert_hotbar_slot_id(pkt.slot as u16);
if let Ok(mut held) = clients.get_mut(packet.client) {
if pkt.slot < 0 || pkt.slot > 8 {
// The client is trying to interact with a slot that does not exist, ignore.
continue;
}
held.held_item_slot = convert_hotbar_slot_id(pkt.slot as u16);

events.send(UpdateSelectedSlot {
client: packet.client,
Expand Down