Package com.blackrook.rookscript

Interface ScriptWaitHandler

public interface ScriptWaitHandler

The wait handler for running scripts. This determines how to

Author:

Matthew Tropiano

Method Summary

Modifier and Type	Method	Description
boolean	waitingScriptCanContinue(ScriptInstance scriptInstance, Object waitType, Object waitParameter)	Called to determine if this waiting script can continue.
void	waitingScriptUpdate(ScriptInstance scriptInstance, Object waitType, Object waitParameter)	Called when waitingScriptCanContinue(ScriptInstance, Object, Object) returns false, in case this script's waiting state needs updating.

Method Details

waitingScriptCanContinue

boolean waitingScriptCanContinue(ScriptInstance scriptInstance,
 Object waitType,
 Object waitParameter)

Called to determine if this waiting script can continue.

Parameters:

scriptInstance - the script instance to test.

waitType - the waiting type.

waitParameter - the waiting type parameter.

Returns:

true if this script can continue on in a RUNNING state, false if not.

waitingScriptUpdate

void waitingScriptUpdate(ScriptInstance scriptInstance,
 Object waitType,
 Object waitParameter)

Called when waitingScriptCanContinue(ScriptInstance, Object, Object) returns false, in case this script's waiting state needs updating.

Parameters:

scriptInstance - the script instance to update.

waitType - the current waiting type.

waitParameter - the current waiting type parameter.