Package gay.object.hexdebug.core.api

Interface HexDebugCoreAPI

public interface HexDebugCoreAPI
Main API service for hexdebug-core. Access via INSTANCE.
Unless otherwise stated, all API methods must be called only from the main server thread.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final HexDebugCoreAPI
    INSTANCE
     

  • Method Summary

    Modifier and Type
    Method
    Description
    default void
    createDebugThread(@NotNull DebugEnvironment debugEnv, @Nullable Integer threadId)
     
    default @Nullable DebugEnvironment
    getDebugEnv(@NotNull at.petrak.hexcasting.api.casting.eval.CastingEnvironment env)
     
    default @Nullable DebugEnvironment
    getDebugEnv(@NotNull net.minecraft.server.level.ServerPlayer caster, @NotNull UUID sessionId)
     
    default void
    printDebugMessage(@NotNull net.minecraft.server.level.ServerPlayer caster, @NotNull UUID sessionId, @NotNull net.minecraft.network.chat.Component message, @NotNull DebugOutputCategory category, boolean withSource)
     
    default void
    startExecuting(@NotNull DebugEnvironment debugEnv, @NotNull at.petrak.hexcasting.api.casting.eval.CastingEnvironment env, @NotNull List<at.petrak.hexcasting.api.casting.iota.Iota> iotas)
     

  • Field Details

  • Method Details

    • getDebugEnv

      @Contract(pure=true) @Nullable default @Nullable DebugEnvironment getDebugEnv(@NotNull @NotNull at.petrak.hexcasting.api.casting.eval.CastingEnvironment env)

    • getDebugEnv

      @Contract(pure=true) @Nullable default @Nullable DebugEnvironment getDebugEnv(@NotNull @NotNull net.minecraft.server.level.ServerPlayer caster, @NotNull @NotNull UUID sessionId)

    • createDebugThread

      default void createDebugThread(@NotNull @NotNull DebugEnvironment debugEnv, @Nullable @Nullable Integer threadId) throws IllegalDebugSessionException, IllegalDebugThreadException
      Throws:
      IllegalDebugSessionException - if debugEnv is currently associated with an active debug session
      IllegalDebugThreadException - if threadId is out of range for the player associated with debugEnv, or currently associated with an active debug session

    • startExecuting

      default void startExecuting(@NotNull @NotNull DebugEnvironment debugEnv, @NotNull @NotNull at.petrak.hexcasting.api.casting.eval.CastingEnvironment env, @NotNull @NotNull List<at.petrak.hexcasting.api.casting.iota.Iota> iotas) throws IllegalDebugSessionException
      Throws:
      IllegalDebugSessionException - if no debug thread is currently associated with debugEnv, or if the debugger is already executing something

    • printDebugMessage

      default void printDebugMessage(@NotNull @NotNull net.minecraft.server.level.ServerPlayer caster, @NotNull @NotNull UUID sessionId, @NotNull @NotNull net.minecraft.network.chat.Component message, @NotNull @NotNull DebugOutputCategory category, boolean withSource)