add documentation

valence-rs · Jun 4, 2024 · 0b5d8d7 · 0b5d8d7
1 parent b4d8e41
commit 0b5d8d7
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/crates/valence_protocol/src/item.rs b/crates/valence_protocol/src/item.rs
@@ -44,6 +44,12 @@ impl ItemStack {
         self
     }
 
+    /// This function takes the "Value" of the skin you want to apply to a PlayerHead.
+    /// The "Value" is a Base64-encoded JSON object that is usually provided by websites.
+    /// To learn more: https://minecraft.wiki/w/Item_format#Player_Heads
+    /// 
+    /// # Errors
+    /// This function returns an error if the [ItemStack] you call it on isn't a PlayerHead
     #[must_use]
     pub fn with_playerhead_texture_value(
         mut self,