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

Class GeyserDefineResourcePacksEvent

java.lang.Object

org.geysermc.geyser.api.event.lifecycle.GeyserDefineResourcePacksEvent

All Implemented Interfaces:

org.geysermc.event.Event

public abstract class GeyserDefineResourcePacksEvent
extends Object
implements org.geysermc.event.Event

Called when ResourcePack's are loaded within Geyser.

Since:

2.6.2

Constructor Summary

Constructors

Constructor	Description
GeyserDefineResourcePacksEvent()

Method Summary

Modifier and Type	Method	Description
abstract @Nullable ResourcePackOption<?>	option(@NonNull UUID uuid, @NonNull ResourcePackOption.Type type)	Returns the current option, or null, for a given ResourcePackOption.Type.
abstract Collection<ResourcePackOption<?>>	options(@NonNull UUID uuid)	Returns a collection of ResourcePackOption's for a registered ResourcePack.
abstract void	register(@NonNull ResourcePack pack, @Nullable ResourcePackOption<?>... options)	Registers a ResourcePack to be sent to the client, optionally alongside ResourcePackOption's specifying how it will be applied on clients.
abstract void	registerOptions(@NonNull UUID uuid, @NonNull ResourcePackOption<?>... options)	Sets ResourcePackOption's for a ResourcePack.
abstract @NonNull List<ResourcePack>	resourcePacks()	Gets the ResourcePack's that will be sent to connecting Bedrock clients.
abstract void	unregister(@NonNull UUID uuid)	Unregisters a ResourcePack from the list of packs sent to connecting Bedrock clients.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

GeyserDefineResourcePacksEvent

public GeyserDefineResourcePacksEvent()

Method Details

resourcePacks

public abstract @NonNull List<ResourcePack> resourcePacks()

Gets the ResourcePack's that will be sent to connecting Bedrock clients. To remove packs, use unregister(UUID), as the list returned by this method is unmodifiable.

Returns:

an unmodifiable list of ResourcePack's

Since:

2.6.2

register

public abstract void register(@NonNull ResourcePack pack,
 @Nullable ResourcePackOption<?>... options)

Registers a ResourcePack to be sent to the client, optionally alongside ResourcePackOption's specifying how it will be applied on clients.

Parameters:

pack - a resource pack that will be sent to the client

options - ResourcePackOption's that specify how clients load the pack

Throws:

ResourcePackException - if an issue occurred during pack registration

Since:

2.6.2

registerOptions

public abstract void registerOptions(@NonNull UUID uuid,
 @NonNull ResourcePackOption<?>... options)

Sets ResourcePackOption's for a ResourcePack.

Parameters:

uuid - the uuid of the resource pack to register the options for

options - the ResourcePackOption's to register for the resource pack

Throws:

ResourcePackException - if an issue occurred during ResourcePackOption registration

Since:

2.6.2

options

public abstract Collection<ResourcePackOption<?>> options(@NonNull UUID uuid)

Returns a collection of ResourcePackOption's for a registered ResourcePack. The collection returned here is not modifiable.

Parameters:

uuid - the uuid of the ResourcePack for which the options are set

Returns:

a collection of ResourcePackOption's

Throws:

ResourcePackException - if the pack was not registered

Since:

2.6.2

option

public abstract @Nullable ResourcePackOption<?> option(@NonNull UUID uuid,
 @NonNull ResourcePackOption.Type type)

Returns the current option, or null, for a given ResourcePackOption.Type.

Parameters:

uuid - the ResourcePack for which to query this option type

type - the ResourcePackOption.Type of the option to query

Throws:

ResourcePackException - if the queried option is invalid or not present on the resource pack

Since:

2.6.2

unregister

public abstract void unregister(@NonNull UUID uuid)

Unregisters a ResourcePack from the list of packs sent to connecting Bedrock clients.

Parameters:

uuid - the UUID of the ResourcePack to be removed

Since:

2.6.2