PluginMessageServerboundToggleVeinMiner

java.lang.Object

wtf.choco.veinminer.network.protocol.serverbound.PluginMessageServerboundToggleVeinMiner

All Implemented Interfaces:: PluginMessage<ServerboundPluginMessageListener>

public final class PluginMessageServerboundToggleVeinMiner extends Object implements PluginMessage<ServerboundPluginMessageListener>

A server bound PluginMessage including the following data:

boolean: whether or not vein miner is active

Sent when a client presses or releases the vein miner activation key bind.

Constructor Summary

Constructors

Constructor

Description

PluginMessageServerboundToggleVeinMiner(boolean activated)

Construct a new PluginMessageServerboundToggleVeinMiner.

PluginMessageServerboundToggleVeinMiner(@NotNull PluginMessageByteBuffer buffer)

Construct a new PluginMessageServerboundToggleVeinMiner with input.
Method Summary

Modifier and Type

Method

Description

void

handle(@NotNull ServerboundPluginMessageListener listener)

Handle this message.

boolean

isActivated()

Check whether or not vein miner is activated.

void

write(@NotNull PluginMessageByteBuffer buffer)

Write this plugin message to the provided PluginMessageByteBuffer.

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

Constructor Details
- PluginMessageServerboundToggleVeinMiner
  
  public PluginMessageServerboundToggleVeinMiner(boolean activated)
  
  Construct a new PluginMessageServerboundToggleVeinMiner.
  
  Parameters:
  
  activated - whether or not vein miner has been activated
- PluginMessageServerboundToggleVeinMiner
  
  @Internal public PluginMessageServerboundToggleVeinMiner(@NotNull @NotNull PluginMessageByteBuffer buffer)
  
  Construct a new PluginMessageServerboundToggleVeinMiner with input.
  
  Parameters:
  
  buffer - the input buffer
Method Details
- isActivated
  
  public boolean isActivated()
  
  Check whether or not vein miner is activated.
  
  Returns:
  
  true if activated, false if deactivated
- write
  
  public void write(@NotNull @NotNull PluginMessageByteBuffer buffer)
  
  Description copied from interface: PluginMessage
  
  Write this plugin message to the provided PluginMessageByteBuffer.
  
  Specified by:
  
  write in interface PluginMessage<ServerboundPluginMessageListener>
  
  Parameters:
  
  buffer - the buffer to which data should be written
- handle
  
  public void handle(@NotNull @NotNull ServerboundPluginMessageListener listener)
  
  Description copied from interface: PluginMessage
  
  Handle this message.
  
  Specified by:
  
  handle in interface PluginMessage<ServerboundPluginMessageListener>
  
  Parameters:
  
  listener - the plugin message listener