org.mini2Dx.miniscript.core

Interface ScriptInvocationListener

All Known Implementing Classes:

InteractiveScriptListener

public interface ScriptInvocationListener

Interface for script execution listeners. Note: All callbacks occur on a different thread from the game thread

Method Summary

Modifier and Type	Method and Description
boolean	callOnGameThread() Returns if this ScriptInvocationListener should be notified on the game thread
default void	onScriptBegin(int scriptId) Called just before a script begins execution.
default void	onScriptCancelled(int scriptId) Called when a script is cancelled while in the invoke queue.
void	onScriptException(int scriptId, java.lang.Exception e) Called when an exception occurs during script execution
void	onScriptSkipped(int scriptId) Called when a script is skipped during execution
void	onScriptSuccess(int scriptId, ScriptExecutionResult executionResult) Called when a script successfully completes

Method Detail

onScriptBegin

default void onScriptBegin(int scriptId)

Called just before a script begins execution. Note: If callOnGameThread() is true, the script will not begin until this callback is processed on the game thread

Parameters:

scriptId - The script id

onScriptCancelled

default void onScriptCancelled(int scriptId)

Called when a script is cancelled while in the invoke queue.

Parameters:

scriptId - The script id

onScriptSuccess

void onScriptSuccess(int scriptId,
                     ScriptExecutionResult executionResult)

Called when a script successfully completes

Parameters:

scriptId - The script id

executionResult - The variable bindings after execution

onScriptSkipped

void onScriptSkipped(int scriptId)

Called when a script is skipped during execution

Parameters:

scriptId - The script id

onScriptException

void onScriptException(int scriptId,
                       java.lang.Exception e)

Called when an exception occurs during script execution

Parameters:

scriptId - The script id

e - The exception that occurred

callOnGameThread

boolean callOnGameThread()

Returns if this ScriptInvocationListener should be notified on the game thread

Returns:

False if this should be notified on the GameScriptingEngine thread pool