org.mini2Dx.miniscript.core

Class EmbeddedScriptInvoker

java.lang.Object

org.mini2Dx.miniscript.core.EmbeddedScriptInvoker

public abstract class EmbeddedScriptInvoker
extends java.lang.Object

Utility class for invoking scripts inside of other scripts

Field Summary

Fields

Modifier and Type	Field and Description
protected GameScriptingEngine	gameScriptingEngine
protected int	parentScriptId
protected ScriptBindings	scriptBindings

Constructor Summary

Constructors

Constructor and Description
EmbeddedScriptInvoker(GameScriptingEngine gameScriptingEngine)

Method Summary

Modifier and Type	Method and Description
int	getScriptId(java.lang.String filepath)
void	invokeAsync(int scriptId) Queues a script for invocation in the game engine.
void	invokeAsync(java.lang.String filepath) Queues a script for invocation in the game engine.
abstract void	invokeSync(int scriptId) Invokes a script during the execution of the current script.
void	invokeSync(java.lang.String filepath) Invokes a script during the execution of the current script.
void	setParentScriptId(int parentScriptId)
void	setScriptBindings(ScriptBindings scriptBindings)

Methods inherited from class java.lang.Object

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

Field Detail

gameScriptingEngine

protected final GameScriptingEngine gameScriptingEngine

parentScriptId

protected int parentScriptId

scriptBindings

protected ScriptBindings scriptBindings

Constructor Detail

EmbeddedScriptInvoker

public EmbeddedScriptInvoker(GameScriptingEngine gameScriptingEngine)

Method Detail

getScriptId

public int getScriptId(java.lang.String filepath)

invokeSync

public abstract void invokeSync(int scriptId)

Invokes a script during the execution of the current script. Equivalent to calling a function.

Parameters:

scriptId - The script ID to invoke

invokeSync

public void invokeSync(java.lang.String filepath)

Invokes a script during the execution of the current script. Equivalent to calling a function.

Parameters:

filepath - The filepath of the script to invoke

invokeAsync

public void invokeAsync(int scriptId)

Queues a script for invocation in the game engine. Depending on the number of script threads and currently excuting scripts, this may invoke simultaneously to the current script.

Parameters:

scriptId - The script ID to invoke

invokeAsync

public void invokeAsync(java.lang.String filepath)

Queues a script for invocation in the game engine. Depending on the number of script threads and currently excuting scripts, this may invoke simultaneously to the current script.

Parameters:

filepath - The filepath of the script to invoke

setScriptBindings

public void setScriptBindings(ScriptBindings scriptBindings)

setParentScriptId

public void setParentScriptId(int parentScriptId)