Package com.viaversion.viaversion.api.debug

Interface DebugHandler

public interface DebugHandler

  • Method Details

    • enabled

      boolean enabled()
      Returns whether debug mode is enabled.
      Returns:
      whether debug mode is enabled

    • setEnabled

      void setEnabled(boolean enabled)
      Sets debug mode.
      Parameters:
      enabled - whether debug should be enabled

    • addPacketTypeNameToLog

      void addPacketTypeNameToLog(String packetTypeName)
      Adds a packet type name to the list of packet types to log.
      Parameters:
      packetTypeName - packet type name

    • addPacketTypeToLog

      void addPacketTypeToLog(PacketType packetType)
      Adds a packet id to the list of packet types to log. Packets will be checked on each protocol transformer, so this is best used on single protocol pipes.
      Parameters:
      packetType - packet type

    • removePacketTypeNameToLog

      boolean removePacketTypeNameToLog(String packetTypeName)
      Removes a packet type name from the list of packet types to log.
      Parameters:
      packetTypeName - packet type name

    • clearPacketTypesToLog

      void clearPacketTypesToLog()
      Resets packet type filters.

    • setLogPacketTransform

      default void setLogPacketTransform(boolean logPacketTransform)
      Sets whether packets should be logged before and after being transformed.
      Parameters:
      logPacketTransform - whether packets should be logged

    • logPrePacketTransform

      boolean logPrePacketTransform()
      Returns whether packets should be logged before being transformed. Set to true by default.
      Returns:
      whether packets should be logged before being transformed

    • setLogPrePacketTransform

      void setLogPrePacketTransform(boolean logPrePacketTransform)
      Sets whether packets should be logged before being transformed.
      Parameters:
      logPrePacketTransform - whether packets should be logged before being transformed

    • logPostPacketTransform

      boolean logPostPacketTransform()
      Returns whether packets should be logged after being transformed. Set to false by default.
      Returns:
      whether packets should be logged after being transformed

    • setLogPostPacketTransform

      void setLogPostPacketTransform(boolean logPostPacketTransform)
      Sets whether packets should be logged after being transformed.
      Parameters:
      logPostPacketTransform - whether packets should be logged after being transformed

    • shouldLog

      boolean shouldLog(PacketWrapper wrapper, Direction direction)
      Returns whether the given packet should be logged. If no specific packet type has been added, all packet types will be logged.
      Parameters:
      wrapper - packet wrapper
      direction - packet direction
      Returns:
      whether the packet should be logged

    • enableAndLogIds

      default void enableAndLogIds(PacketType... packetTypes)

    • error

      default void error(String error, Throwable t)
      Logs an error if debug mode is enabled or error suppression is disabled.
      Parameters:
      error - error message
      t - thrown exception