WrapperPlayServerKickDisconnect (PacketWrapper JavaDocs)

java.lang.Object

com.comphenix.packetwrapper.wrappers.AbstractPacket

com.comphenix.packetwrapper.wrappers.play.clientbound.WrapperPlayServerKickDisconnect

public class WrapperPlayServerKickDisconnect extends AbstractPacket

Send by server to client to disconnect the client. The specified message will be shown on the disconnect screen.

Field Summary

Fields

Modifier and Type

Field

Description

static final com.comphenix.protocol.PacketType

TYPE

The packet type that is wrapped by this wrapper.

Fields inherited from class com.comphenix.packetwrapper.wrappers.AbstractPacket
handle
Constructor Summary

Constructors

Constructor

Description

WrapperPlayServerKickDisconnect()

Constructs a new wrapper and initialize it with a packet handle with default values

WrapperPlayServerKickDisconnect(com.comphenix.protocol.events.PacketContainer packet)

Constructors a new wrapper for the specified packet
Method Summary

Modifier and Type

Method

Description

com.comphenix.protocol.wrappers.WrappedChatComponent

getReason()

Retrieves the kick reason shown on the disconnect screen

void

setReason(com.comphenix.protocol.wrappers.WrappedChatComponent value)

Sets the kick reason shown on the disconnect screen

Methods inherited from class com.comphenix.packetwrapper.wrappers.AbstractPacket
broadcastPacket, equals, getHandle, hashCode, receivePacket, sendPacket

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Details
- TYPE
  
  public static final com.comphenix.protocol.PacketType TYPE
  
  The packet type that is wrapped by this wrapper.
Constructor Details
- WrapperPlayServerKickDisconnect
  
  public WrapperPlayServerKickDisconnect()
  
  Constructs a new wrapper and initialize it with a packet handle with default values
- WrapperPlayServerKickDisconnect
  
  public WrapperPlayServerKickDisconnect(com.comphenix.protocol.events.PacketContainer packet)
  
  Constructors a new wrapper for the specified packet
  
  Parameters:
  
  packet - the packet to wrap
Method Details
- getReason
  
  public com.comphenix.protocol.wrappers.WrappedChatComponent getReason()
  
  Retrieves the kick reason shown on the disconnect screen
  
  Returns:
  
  'reason'
- setReason
  
  public void setReason(com.comphenix.protocol.wrappers.WrappedChatComponent value)
  
  Sets the kick reason shown on the disconnect screen
  
  Parameters:
  
  value - New value for field 'reason'