hexdebug-core-common/gay.object.hexdebug.core.api/HexDebugCoreAPI

HexDebugCoreAPI

public interface HexDebugCoreAPI(source)

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

Functions

createDebugThread

public void createDebugThread(@NotNull() @NotNull() DebugEnvironment debugEnv, @Nullable() @Nullable() Integer threadId)

getDebugEnv

@Contract(pure = true)

@Nullable()

public @Nullable() DebugEnvironment getDebugEnv(@NotNull() @NotNull() CastingEnvironment env)

@Contract(pure = true)

@Nullable()

public @Nullable() DebugEnvironment getDebugEnv(@NotNull() @NotNull() UUID casterId, int threadId)

@Contract(pure = true)

@Nullable()

public @Nullable() DebugEnvironment getDebugEnv(@NotNull() @NotNull() UUID casterId, @NotNull() @NotNull() UUID sessionId)

@Contract(pure = true)

@Nullable()

public @Nullable() DebugEnvironment getDebugEnv(@NotNull() @NotNull() ServerPlayer caster, int threadId)

@Contract(pure = true)

@Nullable()

public @Nullable() DebugEnvironment getDebugEnv(@NotNull() @NotNull() ServerPlayer caster, @NotNull() @NotNull() UUID sessionId)

getFreeDebugThreadId

@Contract(pure = true)

@Nullable()

public @Nullable() Integer getFreeDebugThreadId(@NotNull() @NotNull() UUID casterId)

Returns an arbitrary debug thread ID that is not currently in use by the given player, or null if no threads are currently available.

@Contract(pure = true)

@Nullable()

public @Nullable() Integer getFreeDebugThreadId(@NotNull() @NotNull() ServerPlayer caster)

Returns an arbitrary debug thread ID that is not currently in use by the given player, or null if no threads are available.

isSessionDebugging

@Contract(pure = true)

public boolean isSessionDebugging(@NotNull() @NotNull() DebugEnvironment debugEnv)

printDebugMessage

public void printDebugMessage(@NotNull() @NotNull() ServerPlayer caster, @NotNull() @NotNull() UUID sessionId, @NotNull() @NotNull() Component message, @NotNull() @NotNull() OutputCategory category, boolean withSource)

removeDebugThread

public void removeDebugThread(@NotNull() @NotNull() DebugEnvironment debugEnv)

Removes a debug thread without terminating it.

startDebuggingIotas

public void startDebuggingIotas(@NotNull() @NotNull() DebugEnvironment debugEnv, @NotNull() @NotNull() CastingEnvironment env, @NotNull() @NotNull() List<Iota> iotas, @Nullable() @Nullable() CastingImage image)

terminateDebugThread

public void terminateDebugThread(@NotNull() @NotNull() DebugEnvironment debugEnv)

Terminates and removes a debug thread.