org.mini2Dx.miniscript.ruby

Class RubyGameScriptingEngine

java.lang.Object

org.mini2Dx.miniscript.core.GameScriptingEngine

org.mini2Dx.miniscript.ruby.RubyGameScriptingEngine

All Implemented Interfaces:

java.lang.Runnable

public class RubyGameScriptingEngine
extends org.mini2Dx.miniscript.core.GameScriptingEngine

An implementation of GameScriptingEngine for Ruby-based scripts

Field Summary

Fields inherited from class org.mini2Dx.miniscript.core.GameScriptingEngine

LOCK_PROVIDER, MOST_RECENT_INSTANCE

Constructor Summary

Constructors

Constructor and Description
RubyGameScriptingEngine() Constructs a scripting engine backed by a thread pool with the maximum amount of concurrent scripts set to the amount of processors + 1;
RubyGameScriptingEngine(boolean sandboxed)
RubyGameScriptingEngine(org.mini2Dx.miniscript.core.ClasspathScriptProvider classpathScriptProvider, boolean sandboxed)
RubyGameScriptingEngine(org.mini2Dx.miniscript.core.ClasspathScriptProvider classpathScriptProvider, int maxConcurrentScripts)
RubyGameScriptingEngine(org.mini2Dx.miniscript.core.ClasspathScriptProvider classpathScriptProvider, int maxConcurrentScripts, boolean sandboxed)
RubyGameScriptingEngine(int maxConcurrentScripts) Constructs a scripting engine backed by a thread pool.
RubyGameScriptingEngine(int maxConcurrentScripts, boolean sandboxed)

Method Summary

Modifier and Type	Method and Description
protected org.mini2Dx.miniscript.core.ScriptExecutorPool<?>	createScriptExecutorPool(org.mini2Dx.miniscript.core.ClasspathScriptProvider classpathScriptProvider, int poolSize, boolean sandboxing)
boolean	isEmbeddedSynchronousScriptSupported()
boolean	isSandboxingSupported()

Methods inherited from class org.mini2Dx.miniscript.core.GameScriptingEngine

cancelAllQueuedGameFutures, cancelAllQueuedInteractiveScripts, cancelAllQueuedInteractiveScripts, cancelAllQueuedNonInteractiveScripts, cancelAllQueuedNonInteractiveScripts, cancelAllQueuedScripts, cancelAllQueuedScripts, cancelAllRunningGameFutures, cancelQueuedScript, cancelQueuedScript, cancelQueuedScriptByTaskId, cancelQueuedScriptByTaskId, compileScript, compileScript, compileScript, dispose, dispose, getCompiledScriptId, getRunningScripts, getTotalInteractiveScriptsQueued, getTotalNonInteractiveScriptsQueued, getTotalScriptsQueued, invokeCompiledScript, invokeCompiledScript, invokeCompiledScript, invokeCompiledScript, invokeCompiledScriptSync, invokeCompiledScriptSync, invokeScript, invokeScript, invokeScript, isInteractiveScriptRunning, run, setCancelReallocatedFutures, skipAllQueuedGameFutures, skipAllRunningGameFutures, skipAllScripts, skipOrCancelScript, skipOrCancelScriptByTaskId, skipScript, skipScriptByTaskId, update

Methods inherited from class java.lang.Object

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

Constructor Detail

RubyGameScriptingEngine

public RubyGameScriptingEngine()

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

RubyGameScriptingEngine

public RubyGameScriptingEngine(int maxConcurrentScripts)

Constructs a scripting engine backed by a thread pool.

Parameters:

maxConcurrentScripts - The maximum amount of concurrently running scripts. Note this is a 'requested' amount and may be less due to the amount of available processors on the player's machine.

RubyGameScriptingEngine

public RubyGameScriptingEngine(org.mini2Dx.miniscript.core.ClasspathScriptProvider classpathScriptProvider,
                               int maxConcurrentScripts)

RubyGameScriptingEngine

public RubyGameScriptingEngine(boolean sandboxed)

RubyGameScriptingEngine

public RubyGameScriptingEngine(org.mini2Dx.miniscript.core.ClasspathScriptProvider classpathScriptProvider,
                               boolean sandboxed)

RubyGameScriptingEngine

public RubyGameScriptingEngine(int maxConcurrentScripts,
                               boolean sandboxed)

RubyGameScriptingEngine

public RubyGameScriptingEngine(org.mini2Dx.miniscript.core.ClasspathScriptProvider classpathScriptProvider,
                               int maxConcurrentScripts,
                               boolean sandboxed)

Method Detail

createScriptExecutorPool

protected org.mini2Dx.miniscript.core.ScriptExecutorPool<?> createScriptExecutorPool(org.mini2Dx.miniscript.core.ClasspathScriptProvider classpathScriptProvider,
                                                                                     int poolSize,
                                                                                     boolean sandboxing)

Specified by:

createScriptExecutorPool in class org.mini2Dx.miniscript.core.GameScriptingEngine

isSandboxingSupported

public boolean isSandboxingSupported()

Specified by:

isSandboxingSupported in class org.mini2Dx.miniscript.core.GameScriptingEngine

isEmbeddedSynchronousScriptSupported

public boolean isEmbeddedSynchronousScriptSupported()

Specified by:

isEmbeddedSynchronousScriptSupported in class org.mini2Dx.miniscript.core.GameScriptingEngine