org.mini2Dx.miniscript.core

Class GameFuture

java.lang.Object

org.mini2Dx.miniscript.core.GameFuture

Direct Known Subclasses:

ImmediateGameFuture

public abstract class GameFuture
extends java.lang.Object

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

Field Summary

Fields

Modifier and Type	Field and Description
static long	WAIT_TIMEOUT_MILLIS Set a value if you want waitForCompletion to wake up and check status

Constructor Summary

Constructors

Constructor and Description
GameFuture() Constructor using GameScriptingEngine.MOST_RECENT_INSTANCE
GameFuture(GameScriptingEngine gameScriptingEngine) Constructor

Method Summary

Modifier and Type	Method and Description
protected void	complete()
int	getFutureId() Returns this unique id of this GameFuture instance
boolean	isCompleted() Returns if this GameFuture is complete
boolean	isFutureSkipped() Returns if this GameFuture was skipped
boolean	isReadyForGC() Returns if the GameFuture is ready for cleanup
boolean	isScriptSkipped() Returns if the script was skipped
protected abstract void	onFutureSkipped() Called when the GameFuture is skipped
protected abstract void	onScriptSkipped() Called when the entire script is skipped
void	skipFuture()
protected abstract boolean	update(float delta) Update the GameFuture
void	waitForCompletion() Can be called in a script to wait for this GameFuture to complete
void	wfc() Alias to waitForCompletion()

Methods inherited from class java.lang.Object

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

Field Detail

WAIT_TIMEOUT_MILLIS

public static long WAIT_TIMEOUT_MILLIS

Set a value if you want waitForCompletion to wake up and check status

Constructor Detail

GameFuture

public GameFuture()

Constructor using GameScriptingEngine.MOST_RECENT_INSTANCE

GameFuture

public GameFuture(GameScriptingEngine gameScriptingEngine)

Constructor

Parameters:

gameScriptingEngine - The GameScriptingEngine this future belongs to

Method Detail

update

protected abstract boolean update(float delta)

Update the GameFuture

Parameters:

delta - The amount of time (in seconds) since the last frame

Returns:

True if the GameFuture has completed

onFutureSkipped

protected abstract void onFutureSkipped()

Called when the GameFuture is skipped

onScriptSkipped

protected abstract void onScriptSkipped()

Called when the entire script is skipped

complete

protected void complete()

skipFuture

public void skipFuture()

waitForCompletion

public void waitForCompletion()
                       throws ScriptSkippedException

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

Throws:

ScriptSkippedException - Thrown when the script is skipped

wfc

public void wfc()
         throws ScriptSkippedException

Alias to waitForCompletion()

Throws:

ScriptSkippedException

isCompleted

public boolean isCompleted()

Returns if this GameFuture is complete

Returns:

True if this completed without being skipped

isFutureSkipped

public boolean isFutureSkipped()

Returns if this GameFuture was skipped

Returns:

True if this GameFuture was skipped

isScriptSkipped

public boolean isScriptSkipped()

Returns if the script was skipped

Returns:

True if this GameFuture was waiting for completion when the script was skipped

isReadyForGC

public boolean isReadyForGC()

Returns if the GameFuture is ready for cleanup

Returns:

True if ready for cleanup

getFutureId

public int getFutureId()

Returns this unique id of this GameFuture instance

Returns: