Package com.minecolonies.core.network.messages.server

Class AbstractColonyServerMessage

java.lang.Object
com.minecolonies.core.network.messages.server.AbstractColonyServerMessage
All Implemented Interfaces:
IMessage
Direct Known Subclasses:
AbstractBuildingServerMessage, AdjustSkillCitizenMessage, ChangeFreeToInteractBlockMessage, ColonyFlagChangeMessage, ColonyNameStyleMessage, ColonyStructureStyleMessage, ColonyTextureStyleMessage, DebugEnablePathfindingMessage, FarmFieldRegistrationMessage, FarmFieldUpdateSeedMessage, HireMercenaryMessage, HireSpiesMessage, InteractionClose, InteractionResponse, OpenInventoryMessage, PauseCitizenMessage, PlayerAssistantBuildRequestMessage, QueryCitizenAIHistoryMessage, RestartCitizenMessage, TeamColonyColorChangeMessage, TeleportToColonyMessage, TownHallRenameMessage, TransferItemsToCitizenRequestMessage, TriggerConnectionEventMessage, TriggerSettingMessage, UpdateRequestStateMessage, WorkOrderChangeMessage
public abstract class AbstractColonyServerMessage extends Object implements IMessage

  • Constructor Summary

    Constructors
    Constructor
    Description
    AbstractColonyServerMessage()
    Empty standard constructor.
    AbstractColonyServerMessage(IColony colony)
    Network message for executing things on colonies on the server
    AbstractColonyServerMessage(net.minecraft.resources.ResourceKey<net.minecraft.world.level.Level> dimensionId, int colonyId)
    Network message for executing things on colonies on the server

  • Method Summary

    Modifier and Type
    Method
    Description
    final void
    fromBytes(net.minecraft.network.FriendlyByteBuf buf)
    Reads message data from buffer.
    protected void
    fromBytesAbstractOverride(net.minecraft.network.FriendlyByteBuf buf)
     
    protected abstract void
    fromBytesOverride(net.minecraft.network.FriendlyByteBuf buf)
    Transformation from a byteStream to the variables.
    final net.minecraftforge.fml.LogicalSide
    getExecutionSide()
    Which sides is message able to be executed at.
    final void
    onExecute(net.minecraftforge.network.NetworkEvent.Context ctxIn, boolean isLogicalServer)
    Executes message action.
    protected abstract void
    onExecute(net.minecraftforge.network.NetworkEvent.Context ctxIn, boolean isLogicalServer, IColony colony)
     
    boolean
    ownerOnly()
     
    @Nullable Action
    permissionNeeded()
     
    final void
    toBytes(net.minecraft.network.FriendlyByteBuf buf)
    Writes message data to buffer.
    protected void
    toBytesAbstractOverride(net.minecraft.network.FriendlyByteBuf buf)
     
    protected abstract void
    toBytesOverride(net.minecraft.network.FriendlyByteBuf buf)
    Transformation to a byteStream.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • AbstractColonyServerMessage

      public AbstractColonyServerMessage()
      Empty standard constructor.

    • AbstractColonyServerMessage

      public AbstractColonyServerMessage(IColony colony)
      Network message for executing things on colonies on the server
      Parameters:
      colony - The colony we're executing on

    • AbstractColonyServerMessage

      public AbstractColonyServerMessage(net.minecraft.resources.ResourceKey<net.minecraft.world.level.Level> dimensionId, int colonyId)
      Network message for executing things on colonies on the server
      Parameters:
      dimensionId - The dimension of the colony
      colonyId - The colony ID

  • Method Details

    • permissionNeeded

      @Nullable public @Nullable Action permissionNeeded()

    • ownerOnly

      public boolean ownerOnly()

    • onExecute

      protected abstract void onExecute(net.minecraftforge.network.NetworkEvent.Context ctxIn, boolean isLogicalServer, IColony colony)

    • toBytesOverride

      protected abstract void toBytesOverride(net.minecraft.network.FriendlyByteBuf buf)
      Transformation to a byteStream.
      Parameters:
      buf - the used byteBuffer.

    • toBytesAbstractOverride

      protected void toBytesAbstractOverride(net.minecraft.network.FriendlyByteBuf buf)

    • toBytes

      public final void toBytes(net.minecraft.network.FriendlyByteBuf buf)
      Description copied from interface: IMessage
      Writes message data to buffer.
      Specified by:
      toBytes in interface IMessage
      Parameters:
      buf - network data byte buffer

    • fromBytesOverride

      protected abstract void fromBytesOverride(net.minecraft.network.FriendlyByteBuf buf)
      Transformation from a byteStream to the variables.
      Parameters:
      buf - the used byteBuffer.

    • fromBytesAbstractOverride

      protected void fromBytesAbstractOverride(net.minecraft.network.FriendlyByteBuf buf)

    • fromBytes

      public final void fromBytes(net.minecraft.network.FriendlyByteBuf buf)
      Description copied from interface: IMessage
      Reads message data from buffer.
      Specified by:
      fromBytes in interface IMessage
      Parameters:
      buf - network data byte buffer

    • getExecutionSide

      public final net.minecraftforge.fml.LogicalSide getExecutionSide()
      Description copied from interface: IMessage
      Which sides is message able to be executed at.
      Specified by:
      getExecutionSide in interface IMessage
      Returns:
      CLIENT or SERVER or null (for both)

    • onExecute

      public final void onExecute(net.minecraftforge.network.NetworkEvent.Context ctxIn, boolean isLogicalServer)
      Description copied from interface: IMessage
      Executes message action.
      Specified by:
      onExecute in interface IMessage
      Parameters:
      ctxIn - network context of incoming message
      isLogicalServer - whether message arrived at logical server side