Package com.velocitypowered.api.event.player

Class ServerResourcePackRemoveEvent

java.lang.Object

com.velocitypowered.api.event.player.ServerResourcePackRemoveEvent

All Implemented Interfaces:

ResultedEvent<ResultedEvent.GenericResult>

@AwaitingEvent
public class ServerResourcePackRemoveEvent
extends Object
implements ResultedEvent<ResultedEvent.GenericResult>

This event is fired when the downstream server tries to remove a resource pack from the player or clear all of them. The proxy will wait on this event to finish before forwarding the action to the user. If this event is denied, no resource packs will be removed from the player.

Nested Class Summary

Nested classes/interfaces inherited from interface com.velocitypowered.api.event.ResultedEvent

ResultedEvent.ComponentResult, ResultedEvent.GenericResult, ResultedEvent.Result

Constructor Summary

Constructors

Constructor	Description
ServerResourcePackRemoveEvent(UUID packId, ServerConnection serverConnection)	Instantiates this event.

Method Summary

Modifier and Type	Method	Description
@Nullable UUID	getPackId()	Returns the id of the resource pack, if it's null, all the resource packs from player will be cleared.
ResultedEvent.GenericResult	getResult()	Returns the current ResultedEvent.GenericResult that determines whether the resource pack removal should proceed.
ServerConnection	getServerConnection()	Returns the server that tries to remove a resource pack from the player or clear all of them.
void	setResult(ResultedEvent.GenericResult result)	Sets the ResultedEvent.GenericResult to control whether the resource pack removal proceeds.

Methods inherited from class java.lang.Object

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

Constructor Details

ServerResourcePackRemoveEvent

public ServerResourcePackRemoveEvent(UUID packId,
 ServerConnection serverConnection)

Instantiates this event.

Parameters:

packId - the UUID of the resource pack to remove, or null to clear all

serverConnection - the server attempting to remove the resource pack

Method Details

getPackId

public @Nullable UUID getPackId()

Returns the id of the resource pack, if it's null, all the resource packs from player will be cleared.

Returns:

the id

getServerConnection

public ServerConnection getServerConnection()

Returns the server that tries to remove a resource pack from the player or clear all of them.

Returns:

the server connection

getResult

public ResultedEvent.GenericResult getResult()

Returns the current ResultedEvent.GenericResult that determines whether the resource pack removal should proceed.

By default, the result is allowed(), meaning the resource pack removal or clear will be forwarded to the client unless explicitly denied.

Specified by:

getResult in interface ResultedEvent<ResultedEvent.GenericResult>

Returns:

the current result

setResult

public void setResult(ResultedEvent.GenericResult result)

Sets the ResultedEvent.GenericResult to control whether the resource pack removal proceeds.

Use ResultedEvent.GenericResult.denied() to prevent removal, or ResultedEvent.GenericResult.allowed() to allow it. If denied, the packet will not be forwarded to the player.

Specified by:

setResult in interface ResultedEvent<ResultedEvent.GenericResult>

Parameters:

result - the result to apply to this event

Throws:

NullPointerException - if result is null