Package gay.object.hexdebug.core.api.debugging.env

Class SimplePlayerBasedDebugEnv

java.lang.Object

gay.object.hexdebug.core.api.debugging.env.DebugEnvironment

gay.object.hexdebug.core.api.debugging.env.SimplePlayerBasedDebugEnv

public class SimplePlayerBasedDebugEnv
extends DebugEnvironment

Constructor Summary

Constructors

Constructor	Description
SimplePlayerBasedDebugEnv(@NotNull net.minecraft.server.level.ServerPlayer caster, @NotNull at.petrak.hexcasting.api.casting.eval.CastingEnvironment env, @NotNull List<at.petrak.hexcasting.api.casting.iota.Iota> iotas, @NotNull net.minecraft.network.chat.Component name)

Method Summary

Modifier and Type	Method	Description
@NotNull net.minecraft.network.chat.Component	getName()	Returns a display name for this debug session.
boolean	isCasterInRange()	For in-world debugees, returns whether the caster is close enough to the debuggee to allow debug-related actions to be performed (eg.
void	restart(int threadId)	Attempts to restart the debuggee on the given debug thread.
boolean	resume(@NotNull at.petrak.hexcasting.api.casting.eval.CastingEnvironment env, @NotNull at.petrak.hexcasting.api.casting.eval.vm.CastingImage image, @NotNull at.petrak.hexcasting.api.casting.eval.ResolvedPatternType resolutionType)	Attempts to resume execution of the debuggee.
void	start(@Nullable Integer threadId)
void	terminate()	Terminates the debuggee.

Methods inherited from class gay.object.hexdebug.core.api.debugging.env.DebugEnvironment

getCaster, getLastDebugStepType, getLastEvaluatedAction, getSessionId, isDebugging, printDebugMessage, printDebugMessage, printDebugMessage, printDebugMishap, setLastDebugStepType, setLastEvaluatedAction

Methods inherited from class java.lang.Object

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

Constructor Details

SimplePlayerBasedDebugEnv

public SimplePlayerBasedDebugEnv(@NotNull
 @NotNull net.minecraft.server.level.ServerPlayer caster,
 @NotNull
 @NotNull at.petrak.hexcasting.api.casting.eval.CastingEnvironment env,
 @NotNull
 @NotNull List<at.petrak.hexcasting.api.casting.iota.Iota> iotas,
 @NotNull
 @NotNull net.minecraft.network.chat.Component name)

Method Details

resume

public boolean resume(@NotNull
 @NotNull at.petrak.hexcasting.api.casting.eval.CastingEnvironment env,
 @NotNull
 @NotNull at.petrak.hexcasting.api.casting.eval.vm.CastingImage image,
 @NotNull
 @NotNull at.petrak.hexcasting.api.casting.eval.ResolvedPatternType resolutionType)

Description copied from class: DebugEnvironment

Attempts to resume execution of the debuggee. This is called by the debugger after the current continuation is successfully evaluated to completion.

Specified by:

resume in class DebugEnvironment

Returns:

true if the debug session can continue, or false if the debuggee should be terminated

restart

public void restart(int threadId)

Description copied from class: DebugEnvironment

Attempts to restart the debuggee on the given debug thread. This is called by the debugger when requested by the user.
The previous debug thread is removed before this method is called, so the implementation may use HexDebugCoreAPI.createDebugThread(gay.object.hexdebug.core.api.debugging.env.DebugEnvironment, java.lang.Integer) and HexDebugCoreAPI.startDebuggingIotas(gay.object.hexdebug.core.api.debugging.env.DebugEnvironment, at.petrak.hexcasting.api.casting.eval.CastingEnvironment, java.util.List<at.petrak.hexcasting.api.casting.iota.Iota>, at.petrak.hexcasting.api.casting.eval.vm.CastingImage). However, note that DebugEnvironment is not called before this method, so it's up to the implementation whether they need to call that or not.

Specified by:

restart in class DebugEnvironment

terminate

public void terminate()

Description copied from class: DebugEnvironment

Terminates the debuggee. This is called by the debugger after DebugEnvironment.resume(at.petrak.hexcasting.api.casting.eval.CastingEnvironment, at.petrak.hexcasting.api.casting.eval.vm.CastingImage, at.petrak.hexcasting.api.casting.eval.ResolvedPatternType) returns false, during HexDebugCoreAPI.terminateDebugThread(gay.object.hexdebug.core.api.debugging.env.DebugEnvironment), or when requested by the user.

Specified by:

terminate in class DebugEnvironment

isCasterInRange

public boolean isCasterInRange()

Description copied from class: DebugEnvironment

For in-world debugees, returns whether the caster is close enough to the debuggee to allow debug-related actions to be performed (eg. pause, step, restart).

Specified by:

isCasterInRange in class DebugEnvironment

getName

@NotNull
public @NotNull net.minecraft.network.chat.Component getName()

Description copied from class: DebugEnvironment

Returns a display name for this debug session.
For example, debugger items return the name of the item, and spell circles return the name of the impetus.

Specified by:

getName in class DebugEnvironment

start

public void start(@Nullable
 @Nullable Integer threadId)
           throws IllegalDebugSessionException,
IllegalDebugThreadException

Throws:

IllegalDebugSessionException

IllegalDebugThreadException