mirror of https://github.com/GeyserMC/Geyser.git
110 lines
3.4 KiB
Java
110 lines
3.4 KiB
Java
/*
|
|
* Copyright (c) 2019-2022 GeyserMC. http://geysermc.org
|
|
*
|
|
* 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.
|
|
*
|
|
* @author GeyserMC
|
|
* @link https://github.com/GeyserMC/Geyser
|
|
*/
|
|
|
|
package org.geysermc.geyser.api.item.custom;
|
|
|
|
import org.checkerframework.checker.nullness.qual.NonNull;
|
|
import org.checkerframework.checker.nullness.qual.Nullable;
|
|
import org.geysermc.geyser.api.GeyserApi;
|
|
|
|
/**
|
|
* This is used to store data for a custom item.
|
|
*/
|
|
public interface CustomItemData {
|
|
/**
|
|
* Gets the item's name.
|
|
*
|
|
* @return the item's name
|
|
*/
|
|
@NonNull String name();
|
|
|
|
/**
|
|
* Gets the custom item options of the item.
|
|
*
|
|
* @return the custom item options of the item.
|
|
*/
|
|
CustomItemOptions customItemOptions();
|
|
|
|
/**
|
|
* Gets the item's display name. By default, this is the item's name.
|
|
*
|
|
* @return the item's display name
|
|
*/
|
|
@NonNull String displayName();
|
|
|
|
/**
|
|
* Gets the item's icon. By default, this is the item's name.
|
|
*
|
|
* @return the item's icon
|
|
*/
|
|
@NonNull String icon();
|
|
|
|
/**
|
|
* Gets if the item is allowed to be put into the offhand.
|
|
*
|
|
* @return true if the item is allowed to be used in the offhand, false otherwise
|
|
*/
|
|
boolean allowOffhand();
|
|
|
|
/**
|
|
* Gets the item's texture size. This is to resize the item if the texture is not 16x16.
|
|
*
|
|
* @return the item's texture size
|
|
*/
|
|
int textureSize();
|
|
|
|
/**
|
|
* Gets the item's render offsets. If it is null, the item will be rendered normally, with no offsets.
|
|
*
|
|
* @return the item's render offsets
|
|
*/
|
|
@Nullable CustomRenderOffsets renderOffsets();
|
|
|
|
static CustomItemData.Builder builder() {
|
|
return GeyserApi.api().providerManager().builderProvider().provideBuilder(CustomItemData.Builder.class);
|
|
}
|
|
|
|
interface Builder {
|
|
/**
|
|
* Will also set the display name and icon to the provided parameter, if it is currently not set.
|
|
*/
|
|
Builder name(@NonNull String name);
|
|
|
|
Builder customItemOptions(@NonNull CustomItemOptions customItemOptions);
|
|
|
|
Builder displayName(@NonNull String displayName);
|
|
|
|
Builder icon(@NonNull String icon);
|
|
|
|
Builder allowOffhand(boolean allowOffhand);
|
|
|
|
Builder textureSize(int textureSize);
|
|
|
|
Builder renderOffsets(@Nullable CustomRenderOffsets renderOffsets);
|
|
|
|
CustomItemData build();
|
|
}
|
|
}
|