Package org.geysermc.geyser.api.event.bedrock

Class SessionLoadResourcePacksEvent

java.lang.Object

org.geysermc.geyser.api.event.connection.ConnectionEvent

org.geysermc.geyser.api.event.bedrock.SessionLoadResourcePacksEvent

All Implemented Interfaces:

org.geysermc.event.Event

public abstract class SessionLoadResourcePacksEvent
extends ConnectionEvent

Called when Geyser initializes a session for a new Bedrock client and is in the process of sending ResourcePack's.

Since:

2.1.1

Constructor Summary

Constructors

Constructor	Description
SessionLoadResourcePacksEvent(@NonNull GeyserConnection connection)

Method Summary

Modifier and Type	Method	Description
abstract @Nullable ResourcePackOption<?>	option(@NonNull UUID uuid, @NonNull ResourcePackOption.Type type)	Returns the current ResourcePackOption, 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 boolean	register(@NonNull ResourcePack pack)	Deprecated. Use {register(ResourcePack, ResourcePackOption[])} instead
abstract void	register(@NonNull ResourcePack pack, @Nullable ResourcePackOption<?>... options)	Registers a ResourcePack to be sent to the client, optionally alongside specific ResourcePackOption's specifying how it will be applied by the client.
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 this GeyserConnection.
abstract boolean	unregister(@NonNull UUID uuid)	Unregisters a ResourcePack from the list of packs sent to this GeyserConnection.

Methods inherited from class org.geysermc.geyser.api.event.connection.ConnectionEvent

connection

Methods inherited from class java.lang.Object

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

Constructor Details

SessionLoadResourcePacksEvent

public SessionLoadResourcePacksEvent(@NonNull GeyserConnection connection)

Method Details

resourcePacks

public abstract @NonNull List<ResourcePack> resourcePacks()

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

Returns:

an unmodifiable list of ResourcePack's

Since:

2.1.1

register

@Deprecated
public abstract boolean register(@NonNull ResourcePack pack)

Deprecated.

Use {register(ResourcePack, ResourcePackOption[])} instead

register

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

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

Parameters:

pack - the ResourcePack that will be sent to the client

options - ResourcePackOption's that specify how the client loads 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. This method can also be used to override options for resource packs already registered in the GeyserDefineResourcePacksEvent.

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 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 ResourcePackOption, 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 boolean unregister(@NonNull UUID uuid)

Unregisters a ResourcePack from the list of packs sent to this GeyserConnection.

Parameters:

uuid - the UUID of the ResourcePack to be removed

Since:

2.1.1