Package org.geysermc.geyser.api.event.lifecycle

Interface GeyserDefineCustomItemsEvent

All Superinterfaces:

org.geysermc.event.Event

@NonExtendable
public interface GeyserDefineCustomItemsEvent
extends org.geysermc.event.Event

Called on Geyser's startup when looking for custom items. Custom items must be registered through this event.

This event will not be called if the "add-non-bedrock-items" setting is disabled in the Geyser config.

Method Summary

Modifier and Type	Method	Description
@NonNull Map<Identifier,Collection<CustomItemDefinition>>	customItemDefinitions()	A multimap of all the already registered custom item definitions indexed by the Identifier of the Java item which the item is based on.
@NonNull Map<String,Collection<CustomItemData>>	getExistingCustomItems()	Deprecated. replaced by customItemDefinitions()
@NonNull List<NonVanillaCustomItemData>	getExistingNonVanillaCustomItems()	Deprecated. replaced by nonVanillaCustomItemDefinitions()
@NonNull Map<Identifier,Collection<NonVanillaCustomItemDefinition>>	nonVanillaCustomItemDefinitions()	A multimap of all the already registered non-vanilla custom item definitions indexed by the non-vanilla Java item Identifier these are mapped to.
boolean	register(@NonNull String identifier, @NonNull CustomItemData customItemData)	Deprecated. use register(Identifier, CustomItemDefinition)
boolean	register(@NonNull NonVanillaCustomItemData customItemData)	Deprecated. use register(NonVanillaCustomItemDefinition)
void	register(@NonNull NonVanillaCustomItemDefinition customItemDefinition)	Registers a custom item with no base Java edition item.
void	register(@NonNull Identifier identifier, @NonNull CustomItemDefinition customItemDefinition)	Registers a Bedrock custom item definition based on a Java item.

Method Details

getExistingCustomItems

@Deprecated
@NonNull Map<String,Collection<CustomItemData>> getExistingCustomItems()

Deprecated.

replaced by customItemDefinitions()

A multimap of all the already registered custom items indexed by the item's extended java item's identifier. The map returned here will only contain items registered with the deprecated register(String, CustomItemData) method.

customItemDefinitions

@NonNull Map<Identifier,Collection<CustomItemDefinition>> customItemDefinitions()

A multimap of all the already registered custom item definitions indexed by the Identifier of the Java item which the item is based on.

Since:

2.9.3

getExistingNonVanillaCustomItems

@Deprecated
@NonNull List<NonVanillaCustomItemData> getExistingNonVanillaCustomItems()

Deprecated.

replaced by nonVanillaCustomItemDefinitions()

A list of the already registered non-vanilla custom items. The map returned here will only contain items registered with the deprecated register(NonVanillaCustomItemData) method.

nonVanillaCustomItemDefinitions

@NonNull Map<Identifier,Collection<NonVanillaCustomItemDefinition>> nonVanillaCustomItemDefinitions()

A multimap of all the already registered non-vanilla custom item definitions indexed by the non-vanilla Java item Identifier these are mapped to.

This multimap will, at the moment, always have one entry per key.

Since:

2.9.3

register

@Deprecated
boolean register(@NonNull String identifier,
 @NonNull CustomItemData customItemData)

Deprecated.

use register(Identifier, CustomItemDefinition)

Registers a custom item with a base Java item. This is used to register items with custom textures and properties based on NBT data. This method should not be used anymore, CustomItemDefinitions are preferred now and this method will convert CustomItemData to CustomItemDefinition internally.

Parameters:

identifier - the base (java) item

customItemData - the custom item data to register

Returns:

if the item was registered

register

void register(@NonNull Identifier identifier,
 @NonNull CustomItemDefinition customItemDefinition)

Registers a Bedrock custom item definition based on a Java item. This is used to register items with custom textures and properties created using item data component patches.

Parameters:

identifier - of the Java edition base item

customItemDefinition - the custom item definition to register

Throws:

CustomItemDefinitionRegisterException - when an error occurred while registering the item

Since:

2.9.3

register

@Deprecated
boolean register(@NonNull NonVanillaCustomItemData customItemData)

Deprecated.

use register(NonVanillaCustomItemDefinition)

Registers a custom item with no base item. This is used for mods. This method should not be used anymore, NonVanillaCustomItemDefinitions are preferred now and this method will convert NonVanillaCustomItemData to NonVanillaCustomItemDefinition internally.

Parameters:

customItemData - the custom item data to register

Returns:

if the item was registered

register

void register(@NonNull NonVanillaCustomItemDefinition customItemDefinition)

Registers a custom item with no base Java edition item. This is used for non-vanilla items added by mods.

Parameters:

customItemDefinition - the custom item definition to register

Throws:

CustomItemDefinitionRegisterException - when an error occurred while registering the item

Since:

2.9.3