org.mini2Dx.miniscript.core

Class InteractiveScriptListener

java.lang.Object

org.mini2Dx.miniscript.core.InteractiveScriptListener

All Implemented Interfaces:

ScriptInvocationListener

public class InteractiveScriptListener
extends java.lang.Object
implements ScriptInvocationListener

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	NOTIFY_THEN_ALLOW_INTERACTION When true sends notifications then allows next interaction script.
static boolean	WAIT_FOR_GAME_THREAD_NOTIFICATIONS When true waits for game thread notifications to be processed before proceeding

Constructor Summary

Constructors

Constructor and Description
InteractiveScriptListener(GameScriptingEngine scriptingEngine, ScriptInvocationQueue invocationQueue)

Method Summary

Modifier and Type	Method and Description
boolean	callOnGameThread() Returns if this ScriptInvocationListener should be notified on the game thread
ScriptInvocationListener	getInvocationListener()
void	onScriptBegin(int scriptId) Called just before a script begins execution.
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
void	track(int scriptId, ScriptInvocationListener invocationListener)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.mini2Dx.miniscript.core.ScriptInvocationListener

onScriptCancelled

Field Detail

NOTIFY_THEN_ALLOW_INTERACTION

public static boolean NOTIFY_THEN_ALLOW_INTERACTION

When true sends notifications then allows next interaction script. Defaults to false which allows next interaction script then notifies.

WAIT_FOR_GAME_THREAD_NOTIFICATIONS

public static boolean WAIT_FOR_GAME_THREAD_NOTIFICATIONS

When true waits for game thread notifications to be processed before proceeding

Constructor Detail

InteractiveScriptListener

public InteractiveScriptListener(GameScriptingEngine scriptingEngine,
                                 ScriptInvocationQueue invocationQueue)

Method Detail

track

public void track(int scriptId,
                  ScriptInvocationListener invocationListener)

onScriptBegin

public void onScriptBegin(int scriptId)

Description copied from interface: ScriptInvocationListener

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

Specified by:

onScriptBegin in interface ScriptInvocationListener

Parameters:

scriptId - The script id

onScriptSuccess

public void onScriptSuccess(int scriptId,
                            ScriptExecutionResult executionResult)

Description copied from interface: ScriptInvocationListener

Called when a script successfully completes

Specified by:

onScriptSuccess in interface ScriptInvocationListener

Parameters:

scriptId - The script id

executionResult - The variable bindings after execution

onScriptSkipped

public void onScriptSkipped(int scriptId)

Description copied from interface: ScriptInvocationListener

Called when a script is skipped during execution

Specified by:

onScriptSkipped in interface ScriptInvocationListener

Parameters:

scriptId - The script id

onScriptException

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

Description copied from interface: ScriptInvocationListener

Called when an exception occurs during script execution

Specified by:

onScriptException in interface ScriptInvocationListener

Parameters:

scriptId - The script id

e - The exception that occurred

getInvocationListener

public ScriptInvocationListener getInvocationListener()

callOnGameThread

public boolean callOnGameThread()

Description copied from interface: ScriptInvocationListener

Returns if this ScriptInvocationListener should be notified on the game thread

Specified by:

callOnGameThread in interface ScriptInvocationListener

Returns:

False if this should be notified on the GameScriptingEngine thread pool