ViaVersion/api/src/main/java/com/viaversion/viaversion/api/minecraft/item/Item.java

98 lines
2.6 KiB
Java

/*
* This file is part of ViaVersion - https://github.com/ViaVersion/ViaVersion
* Copyright (C) 2016-2024 ViaVersion and contributors
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all
* copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*/
package com.viaversion.viaversion.api.minecraft.item;
import com.github.steveice10.opennbt.tag.builtin.CompoundTag;
import org.checkerframework.checker.nullness.qual.Nullable;
public interface Item {
/**
* Returns the item identifier.
*
* @return item identifier
*/
int identifier();
/**
* Sets the item identifier.
*
* @param identifier item identifier
*/
void setIdentifier(int identifier);
/**
* Returns the item amount.
*
* @return item amount
*/
int amount();
/**
* Returns the item amount.
*
* @param amount item amount
*/
void setAmount(int amount);
/**
* Returns the item data. Always 0 for 1.13+ items.
*
* @return item data
*/
default short data() {
return 0;
}
/**
* Sets the item data used in versions before 1.13.
*
* @param data item data
* @throws UnsupportedOperationException if the item implementation does not store data
*/
default void setData(short data) {
throw new UnsupportedOperationException();
}
/**
* Returns the item compound tag if present.
*
* @return item tag
*/
@Nullable CompoundTag tag();
/**
* Sets the item compound tag.
*
* @param tag item tag
*/
void setTag(@Nullable CompoundTag tag);
/**
* Returns a copy of the item.
*
* @return copy of the item
*/
Item copy();
}