Package com.github.retrooper.packetevents.event

Class ProtocolPacketEvent

java.lang.Object

com.github.retrooper.packetevents.event.PacketEvent

com.github.retrooper.packetevents.event.ProtocolPacketEvent

All Implemented Interfaces:

CallableEvent, CancellableEvent, PlayerEvent, UserEvent

Direct Known Subclasses:

PacketReceiveEvent, PacketSendEvent

public abstract class ProtocolPacketEvent
extends PacketEvent
implements PlayerEvent, CancellableEvent, UserEvent

Constructor Summary

Constructors

Constructor	Description
ProtocolPacketEvent(int packetID, PacketTypeCommon packetType, ServerVersion serverVersion, Object channel, User user, Object player, Object byteBuf)
ProtocolPacketEvent(PacketSide packetSide, Object channel, User user, Object player, Object byteBuf, boolean autoProtocolTranslation)

Method Summary

Modifier and Type	Method	Description
void	cleanUp()
ProtocolPacketEvent	clone()
SocketAddress	getAddress()
Object	getByteBuf()
Object	getChannel()
ClientVersion	getClientVersion()	Deprecated.
ConnectionState	getConnectionState()
Object	getFullBufferClone()
@Nullable PacketWrapper<?>	getLastUsedWrapper()
int	getPacketId()
String	getPacketName()	Deprecated.
PacketTypeCommon	getPacketType()
<T> T	getPlayer()	Associated player.
List<Runnable>	getPostTasks()
ServerVersion	getServerVersion()
InetSocketAddress	getSocketAddress()	WARNING: This doesn't support local addresses or unix sockets.
User	getUser()
boolean	hasPostTasks()
boolean	isCancelled()	This method returns if the event will be cancelled.
boolean	isClone()
void	markForReEncode(boolean needsReEncode)
boolean	needsReEncode()
void	setByteBuf(Object byteBuf)
void	setCancelled(boolean val)	Cancel or proceed with the event.
void	setClientVersion(@NotNull ClientVersion clientVersion)	Deprecated.
void	setLastUsedWrapper(@Nullable PacketWrapper<?> lastUsedWrapper)
void	setServerVersion(@NotNull ServerVersion serverVersion)

Methods inherited from class com.github.retrooper.packetevents.event.PacketEvent

callPacketEventExternal, getTimestamp

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.github.retrooper.packetevents.event.CallableEvent

call

Constructor Details

ProtocolPacketEvent

public ProtocolPacketEvent(PacketSide packetSide,
 Object channel,
 User user,
 Object player,
 Object byteBuf,
 boolean autoProtocolTranslation)
                    throws PacketProcessException

Throws:

PacketProcessException

ProtocolPacketEvent

public ProtocolPacketEvent(int packetID,
 PacketTypeCommon packetType,
 ServerVersion serverVersion,
 Object channel,
 User user,
 Object player,
 Object byteBuf)

Method Details

markForReEncode

public void markForReEncode(boolean needsReEncode)

needsReEncode

public boolean needsReEncode()

isClone

public boolean isClone()

getChannel

public Object getChannel()

getAddress

public SocketAddress getAddress()

getSocketAddress

public InetSocketAddress getSocketAddress()

WARNING: This doesn't support local addresses or unix sockets.

getUser

public User getUser()

Specified by:

getUser in interface UserEvent

getPlayer

public <T> T getPlayer()

Description copied from interface: PlayerEvent

Associated player.

Specified by:

getPlayer in interface PlayerEvent

Returns:

Player.

getConnectionState

public ConnectionState getConnectionState()

getClientVersion

@Deprecated
public ClientVersion getClientVersion()

Deprecated.

setClientVersion

@Deprecated
public void setClientVersion(@NotNull
 @NotNull ClientVersion clientVersion)

Deprecated.

getServerVersion

public ServerVersion getServerVersion()

setServerVersion

public void setServerVersion(@NotNull
 @NotNull ServerVersion serverVersion)

getByteBuf

public Object getByteBuf()

setByteBuf

public void setByteBuf(Object byteBuf)

getPacketId

public int getPacketId()

getPacketType

public PacketTypeCommon getPacketType()

getPacketName

@Deprecated
public String getPacketName()

Deprecated.

isCancelled

public boolean isCancelled()

Description copied from interface: CancellableEvent

This method returns if the event will be cancelled.

Specified by:

isCancelled in interface CancellableEvent

Returns:

Will the event be cancelled.

setCancelled

public void setCancelled(boolean val)

Description copied from interface: CancellableEvent

Cancel or proceed with the event.

Specified by:

setCancelled in interface CancellableEvent

Parameters:

val - Is the event cancelled

getLastUsedWrapper

@Nullable
public @Nullable PacketWrapper<?> getLastUsedWrapper()

setLastUsedWrapper

public void setLastUsedWrapper(@Nullable
 @Nullable PacketWrapper<?> lastUsedWrapper)

getPostTasks

public List<Runnable> getPostTasks()

hasPostTasks

public boolean hasPostTasks()

clone

public ProtocolPacketEvent clone()

Overrides:

clone in class Object

cleanUp

public void cleanUp()

getFullBufferClone

public Object getFullBufferClone()