A C D E G H I K M O P R S T U V W

A

allocate(int, ScriptBindings, ScriptInvocationListener) - Method in class org.mini2Dx.miniscript.core.ScriptInvocationPool

Allocate a ScriptInvocation instance

C

callOnGameThread() - Method in interface org.mini2Dx.miniscript.core.ScriptInvocationListener

Returns if this ScriptInvocationListener should be notified on the game thread

cleanup() - Method in class org.mini2Dx.miniscript.core.ScriptExecutionTask

clear() - Method in class org.mini2Dx.miniscript.core.ScriptBindings

compile(String) - Method in interface org.mini2Dx.miniscript.core.ScriptExecutor

compileScript(String) - Method in class org.mini2Dx.miniscript.core.GameScriptingEngine

Compiles a script for execution.

compileScript(InputStream) - Method in class org.mini2Dx.miniscript.core.GameScriptingEngine

Compiles a script for execution.

containsKey(Object) - Method in class org.mini2Dx.miniscript.core.ScriptBindings

containsValue(Object) - Method in class org.mini2Dx.miniscript.core.ScriptBindings

createScriptExecutorPool(int, boolean) - Method in class org.mini2Dx.miniscript.core.GameScriptingEngine

D

dispose() - Method in class org.mini2Dx.miniscript.core.GameScriptingEngine

Shuts down the thread pool and cleans up resources

duplicate() - Method in class org.mini2Dx.miniscript.core.ScriptBindings

Creates a duplicate instance of this ScriptBindings

E

entrySet() - Method in class org.mini2Dx.miniscript.core.ScriptBindings

execute(GameScript<S>, ScriptBindings, boolean) - Method in interface org.mini2Dx.miniscript.core.ScriptExecutor

execute(int, ScriptBindings, ScriptInvocationListener) - Method in interface org.mini2Dx.miniscript.core.ScriptExecutorPool

G

GameFuture - Class in org.mini2Dx.miniscript.core

Represents a task that will complete in-game at a future time

GameFuture() - Constructor for class org.mini2Dx.miniscript.core.GameFuture

Constructor using GameScriptingEngine.MOST_RECENT_INSTANCE

GameFuture(GameScriptingEngine) - Constructor for class org.mini2Dx.miniscript.core.GameFuture

Constructor

GameScript<S> - Class in org.mini2Dx.miniscript.core

Wraps the native script object with an identifier

GameScript() - Constructor for class org.mini2Dx.miniscript.core.GameScript

GameScriptingEngine - Class in org.mini2Dx.miniscript.core

Provides scripting functionality to your game Note that this is a base class for each scripting language implementation.

GameScriptingEngine() - Constructor for class org.mini2Dx.miniscript.core.GameScriptingEngine

Constructs a scripting engine backed by a thread pool with the maximum amount of concurrent scripts set to the amount of processors + 1.

GameScriptingEngine(int) - Constructor for class org.mini2Dx.miniscript.core.GameScriptingEngine

Constructs a scripting engine backed by a thread pool.

GameScriptingEngine(boolean) - Constructor for class org.mini2Dx.miniscript.core.GameScriptingEngine

Constructs a scripting engine backed by a thread pool with the maximum amount of concurrent scripts set to the amount of processors + 1.

GameScriptingEngine(int, boolean) - Constructor for class org.mini2Dx.miniscript.core.GameScriptingEngine

Constructs a scripting engine backed by a thread pool.

get(Object) - Method in class org.mini2Dx.miniscript.core.ScriptBindings

getContent() - Method in class org.mini2Dx.miniscript.core.PerThreadGameScript

getFutureId() - Method in class org.mini2Dx.miniscript.core.GameFuture

Returns this unique id of this GameFuture instance

getGameScriptingEngine() - Method in interface org.mini2Dx.miniscript.core.ScriptExecutorPool

getId() - Method in class org.mini2Dx.miniscript.core.GameScript

getInvocationListener() - Method in class org.mini2Dx.miniscript.core.ScriptInvocation

getScript() - Method in class org.mini2Dx.miniscript.core.GameScript

getScript() - Method in class org.mini2Dx.miniscript.core.GlobalGameScript

getScript() - Method in class org.mini2Dx.miniscript.core.PerThreadGameScript

getScriptBindings() - Method in class org.mini2Dx.miniscript.core.ScriptInvocation

getScriptId() - Method in class org.mini2Dx.miniscript.core.ScriptExecutionTask

getScriptId() - Method in class org.mini2Dx.miniscript.core.ScriptInvocation

getTaskId() - Method in class org.mini2Dx.miniscript.core.ScriptExecutionTask

GlobalGameScript<S> - Class in org.mini2Dx.miniscript.core

An implementation of GameScript for language runtimes where script execution is isolated regardless of the thread it is executing on

GlobalGameScript(S) - Constructor for class org.mini2Dx.miniscript.core.GlobalGameScript

H

hasLocalScript() - Method in class org.mini2Dx.miniscript.core.PerThreadGameScript

I

ImmediateGameFuture - Class in org.mini2Dx.miniscript.core

A GameFuture that completes immediately

ImmediateGameFuture() - Constructor for class org.mini2Dx.miniscript.core.ImmediateGameFuture

Constructor using GameScriptingEngine.MOST_RECENT_INSTANCE

ImmediateGameFuture(GameScriptingEngine) - Constructor for class org.mini2Dx.miniscript.core.ImmediateGameFuture

Constructor

InsufficientCompilersException - Exception in org.mini2Dx.miniscript.core.exception

Thrown when all compilers are currently in use

InsufficientCompilersException() - Constructor for exception org.mini2Dx.miniscript.core.exception.InsufficientCompilersException

invokeCompiledScript(int, ScriptBindings) - Method in class org.mini2Dx.miniscript.core.GameScriptingEngine

Queues a compiled script for execution in the engine's thread pool

invokeCompiledScript(int, ScriptBindings, ScriptInvocationListener) - Method in class org.mini2Dx.miniscript.core.GameScriptingEngine

Queues a compiled script for execution in the engine's thread pool

invokeCompiledScriptLocally(int, ScriptBindings) - Method in class org.mini2Dx.miniscript.core.GameScriptingEngine

Executes a compiled script immediately on the thread calling this method.

invokeCompiledScriptLocally(int, ScriptBindings, ScriptInvocationListener) - Method in class org.mini2Dx.miniscript.core.GameScriptingEngine

Executes a compiled script immediately on the thread calling this method.

invokeScript(String, ScriptBindings) - Method in class org.mini2Dx.miniscript.core.GameScriptingEngine

Compiles and queues a script for execution in the engine's thread pool

invokeScript(String, ScriptBindings, ScriptInvocationListener) - Method in class org.mini2Dx.miniscript.core.GameScriptingEngine

Compiles and queues a script for execution in the engine's thread pool

isCompleted() - Method in class org.mini2Dx.miniscript.core.GameFuture

Returns if this GameFuture is complete

isEmpty() - Method in class org.mini2Dx.miniscript.core.ScriptBindings

isFinished() - Method in class org.mini2Dx.miniscript.core.ScriptExecutionTask

isFutureSkipped() - Method in class org.mini2Dx.miniscript.core.GameFuture

Returns if this GameFuture was skipped

isReadyForGC() - Method in class org.mini2Dx.miniscript.core.GameFuture

Returns if the GameFuture is ready for cleanup

isSandboxingSupported() - Method in class org.mini2Dx.miniscript.core.GameScriptingEngine

Checks if sandboxing is supported by the GameScriptingEngine implementation

isScriptSkipped() - Method in class org.mini2Dx.miniscript.core.GameFuture

Returns if the script was skipped

K

keySet() - Method in class org.mini2Dx.miniscript.core.ScriptBindings

M

MOST_RECENT_INSTANCE - Static variable in class org.mini2Dx.miniscript.core.GameScriptingEngine

Returns the most recently created GameScriptingEngine

O

onFutureSkipped() - Method in class org.mini2Dx.miniscript.core.GameFuture

Called when the GameFuture is skipped

onFutureSkipped() - Method in class org.mini2Dx.miniscript.core.ImmediateGameFuture

onScriptException(int, Exception) - Method in interface org.mini2Dx.miniscript.core.ScriptInvocationListener

Called when an exception occurs during script execution

onScriptSkipped() - Method in class org.mini2Dx.miniscript.core.GameFuture

Called when the entire script is skipped

onScriptSkipped() - Method in class org.mini2Dx.miniscript.core.ImmediateGameFuture

onScriptSkipped(int) - Method in interface org.mini2Dx.miniscript.core.ScriptInvocationListener

Called when a script is skipped

onScriptSuccess(int, ScriptExecutionResult) - Method in interface org.mini2Dx.miniscript.core.ScriptInvocationListener

Called when a script successfully completes

org.mini2Dx.miniscript.core - package org.mini2Dx.miniscript.core

org.mini2Dx.miniscript.core.exception - package org.mini2Dx.miniscript.core.exception

org.mini2Dx.miniscript.core.notification - package org.mini2Dx.miniscript.core.notification

P

PerThreadGameScript<S> - Class in org.mini2Dx.miniscript.core

An implementation of GameScript for language runtimes where a script must be compiled on a per thread basis

PerThreadGameScript(String) - Constructor for class org.mini2Dx.miniscript.core.PerThreadGameScript

preCompileScript(String) - Method in interface org.mini2Dx.miniscript.core.ScriptExecutorPool

process() - Method in class org.mini2Dx.miniscript.core.notification.ScriptExceptionNotification

process() - Method in interface org.mini2Dx.miniscript.core.notification.ScriptNotification

process() - Method in class org.mini2Dx.miniscript.core.notification.ScriptSkippedNotification

process() - Method in class org.mini2Dx.miniscript.core.notification.ScriptSuccessNotification

put(String, Object) - Method in class org.mini2Dx.miniscript.core.ScriptBindings

putAll(Map<? extends String, ? extends Object>) - Method in class org.mini2Dx.miniscript.core.ScriptBindings

putLocalScript(S) - Method in class org.mini2Dx.miniscript.core.PerThreadGameScript

R

release() - Method in interface org.mini2Dx.miniscript.core.ScriptExecutor

release(ScriptExecutor<S>) - Method in interface org.mini2Dx.miniscript.core.ScriptExecutorPool

release() - Method in class org.mini2Dx.miniscript.core.ScriptInvocation

release(ScriptInvocation) - Method in class org.mini2Dx.miniscript.core.ScriptInvocationPool

Releases a ScriptInvocation back to the pool

remove(Object) - Method in class org.mini2Dx.miniscript.core.ScriptBindings

run() - Method in class org.mini2Dx.miniscript.core.GameScriptingEngine

This should not be invoked by the developer.

run() - Method in class org.mini2Dx.miniscript.core.ScriptExecutionTask

S

SandboxingUnsupportedException - Exception in org.mini2Dx.miniscript.core.exception

Thrown when miniscript doesn't support sandboxing for the chosen scripting language

SandboxingUnsupportedException(String) - Constructor for exception org.mini2Dx.miniscript.core.exception.SandboxingUnsupportedException

ScriptBindings - Class in org.mini2Dx.miniscript.core

A mapping of variable names to objects passed to a script

ScriptBindings() - Constructor for class org.mini2Dx.miniscript.core.ScriptBindings

ScriptExceptionNotification - Class in org.mini2Dx.miniscript.core.notification

ScriptExceptionNotification(ScriptInvocationListener, int, Exception) - Constructor for class org.mini2Dx.miniscript.core.notification.ScriptExceptionNotification

ScriptExecutionResult - Class in org.mini2Dx.miniscript.core

Stores the variable mappings after a script's execution

ScriptExecutionResult(Map<String, Object>) - Constructor for class org.mini2Dx.miniscript.core.ScriptExecutionResult

ScriptExecutionTask<S> - Class in org.mini2Dx.miniscript.core

Executes a script

ScriptExecutionTask(GameScriptingEngine, ScriptExecutor<S>, GameScript<S>, ScriptBindings, ScriptInvocationListener) - Constructor for class org.mini2Dx.miniscript.core.ScriptExecutionTask

ScriptExecutor<S> - Interface in org.mini2Dx.miniscript.core

Common interface for language-specific script executors.

ScriptExecutorPool<S> - Interface in org.mini2Dx.miniscript.core

Common interface for language-specific ScriptExecutor pools.

ScriptExecutorUnavailableException - Exception in org.mini2Dx.miniscript.core.exception

Called when a script is attempting to execute but a ScriptExecutor in unavailable

ScriptExecutorUnavailableException(int) - Constructor for exception org.mini2Dx.miniscript.core.exception.ScriptExecutorUnavailableException

ScriptInvocation - Class in org.mini2Dx.miniscript.core

Wraps a script invocation so it can be queued concurrently

ScriptInvocation(ScriptInvocationPool) - Constructor for class org.mini2Dx.miniscript.core.ScriptInvocation

ScriptInvocationListener - Interface in org.mini2Dx.miniscript.core

Interface for script execution listeners.

ScriptInvocationPool - Class in org.mini2Dx.miniscript.core

Provides a pool of reusable ScriptInvocation instances to reduce object allocation

ScriptInvocationPool() - Constructor for class org.mini2Dx.miniscript.core.ScriptInvocationPool

ScriptNotification - Interface in org.mini2Dx.miniscript.core.notification

ScriptSkippedException - Exception in org.mini2Dx.miniscript.core.exception

Thrown when a script was skipped

ScriptSkippedException() - Constructor for exception org.mini2Dx.miniscript.core.exception.ScriptSkippedException

ScriptSkippedNotification - Class in org.mini2Dx.miniscript.core.notification

ScriptSkippedNotification(ScriptInvocationListener, int) - Constructor for class org.mini2Dx.miniscript.core.notification.ScriptSkippedNotification

ScriptSuccessNotification - Class in org.mini2Dx.miniscript.core.notification

ScriptSuccessNotification(ScriptInvocationListener, int, ScriptExecutionResult) - Constructor for class org.mini2Dx.miniscript.core.notification.ScriptSuccessNotification

setCancelReallocatedFutures(boolean) - Method in class org.mini2Dx.miniscript.core.GameScriptingEngine

Sets if newly GameFutures should cancel a previously scheduled GameFuture with the same ID.

setInvocationListener(ScriptInvocationListener) - Method in class org.mini2Dx.miniscript.core.ScriptInvocation

setScriptBindings(ScriptBindings) - Method in class org.mini2Dx.miniscript.core.ScriptInvocation

setScriptId(int) - Method in class org.mini2Dx.miniscript.core.ScriptInvocation

setTaskFuture(Future<?>) - Method in class org.mini2Dx.miniscript.core.ScriptExecutionTask

size() - Method in class org.mini2Dx.miniscript.core.ScriptBindings

skipAllGameFutures() - Method in class org.mini2Dx.miniscript.core.GameScriptingEngine

Skips all currently running GameFutures

skipAllScripts() - Method in class org.mini2Dx.miniscript.core.GameScriptingEngine

Skips all currently running scripts

skipFuture() - Method in class org.mini2Dx.miniscript.core.GameFuture

skipScript(int) - Method in class org.mini2Dx.miniscript.core.GameScriptingEngine

Skips a currently running script

skipScript() - Method in class org.mini2Dx.miniscript.core.ScriptExecutionTask

T

toString() - Method in class org.mini2Dx.miniscript.core.ScriptBindings

U

update(float) - Method in class org.mini2Dx.miniscript.core.GameFuture

Update the GameFuture

update(float) - Method in class org.mini2Dx.miniscript.core.GameScriptingEngine

Updates all GameFutures

update(float) - Method in class org.mini2Dx.miniscript.core.ImmediateGameFuture

V

values() - Method in class org.mini2Dx.miniscript.core.ScriptBindings

W

waitForCompletion() - Method in class org.mini2Dx.miniscript.core.GameFuture

Can be called in a script to wait for this GameFuture to complete

A C D E G H I K M O P R S T U V W