org.bytedeco.ale

Class StellaEnvironment

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.ale.StellaEnvironment

All Implemented Interfaces:

AutoCloseable

@NoOffset
 @Properties(inherit=ale.class)
public class StellaEnvironment
extends Pointer

Nested Class Summary

Nested classes/interfaces inherited from class org.bytedeco.javacpp.Pointer

Pointer.CustomDeallocator, Pointer.Deallocator, Pointer.NativeDeallocator, Pointer.ReferenceCounter

Field Summary

Fields inherited from class org.bytedeco.javacpp.Pointer

address, capacity, limit, position

Constructor Summary

Constructors

Constructor and Description
StellaEnvironment(OSystem system, RomSettings settings)
StellaEnvironment(Pointer p) Pointer cast constructor.

Method Summary

Modifier and Type	Method and Description
int	act(int player_a_action, int player_b_action) Applies the given actions (e.g.
ALEState	cloneState() Returns a copy of the current emulator state.
ALEState	cloneSystemState() Returns a copy of the current emulator state.
int	getEpisodeFrameNumber()
int	getFrameNumber()
ALERAM	getRAM()
ALEScreen	getScreen() Returns the current screen after processing (e.g.
ALEState	getState()
StellaEnvironmentWrapper	getWrapper() Returns a wrapper providing #include-free access to our methods.
boolean	isTerminal() Returns true once we reach a terminal state
void	load()
void	pressSelect()
void	pressSelect(long num_steps) Keep pressing the console select button for a given amount of time
void	reset() Resets the system to its start state.
void	restoreState(ALEState arg0) Restores a previously saved copy of the state.
void	restoreSystemState(ALEState arg0) Restores a previously saved copy of the state, including RNG state information.
void	save() Save/restore the environment state onto the stack.
void	setDifficulty(int value) Set the difficulty according to the value.
void	setMode(int value) Set the game mode according to the value.
void	setState(ALEState state) Accessor methods for the environment state.
void	softReset() This functions emulates a push on the reset button of the console

Methods inherited from class org.bytedeco.javacpp.Pointer

address, asBuffer, asByteBuffer, availablePhysicalBytes, calloc, capacity, capacity, close, deallocate, deallocate, deallocateReferences, deallocator, deallocator, equals, fill, formatBytes, free, getPointer, getPointer, getPointer, getPointer, hashCode, isNull, isNull, limit, limit, malloc, maxBytes, maxPhysicalBytes, memchr, memcmp, memcpy, memmove, memset, offsetof, offsetof, parseBytes, physicalBytes, position, position, put, realloc, referenceCount, releaseReference, retainReference, setNull, sizeof, sizeof, toString, totalBytes, totalCount, totalPhysicalBytes, withDeallocator, zero

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

StellaEnvironment

public StellaEnvironment(Pointer p)

Pointer cast constructor. Invokes Pointer.Pointer(Pointer).

StellaEnvironment

public StellaEnvironment(OSystem system,
                         RomSettings settings)

Method Detail

reset

public void reset()

Resets the system to its start state.

save

public void save()

Save/restore the environment state onto the stack.

load

public void load()

cloneState

@ByVal
public ALEState cloneState()

Returns a copy of the current emulator state. Note that this doesn't include pseudorandomness, so that clone/restoreState are suitable for planning.

restoreState

public void restoreState(@Const @ByRef
                         ALEState arg0)

Restores a previously saved copy of the state.

cloneSystemState

@ByVal
public ALEState cloneSystemState()

Returns a copy of the current emulator state. This includes RNG state information, and more generally should lead to exactly reproducibility.

restoreSystemState

public void restoreSystemState(@Const @ByRef
                               ALEState arg0)

Restores a previously saved copy of the state, including RNG state information.

act

@Cast(value="reward_t")
public int act(@Cast(value="Action")
                                        int player_a_action,
                                        @Cast(value="Action")
                                        int player_b_action)

Applies the given actions (e.g. updating paddle positions when the paddle is used) and performs one simulation step in Stella. Returns the resultant reward. When frame skip is set to > 1, up the corresponding number of simulation steps are performed. Note that the post-act() frame number might not correspond to the pre-act() frame number plus the frame skip.

softReset

public void softReset()

This functions emulates a push on the reset button of the console

pressSelect

public void pressSelect(@Cast(value="size_t")
                        long num_steps)

Keep pressing the console select button for a given amount of time

pressSelect

public void pressSelect()

setDifficulty

public void setDifficulty(@Cast(value="difficulty_t")
                          int value)

Set the difficulty according to the value. If the first bit is 1, then it will put the left difficulty switch to A (otherwise leave it on B) If the second bit is 1, then it will put the right difficulty switch to A (otherwise leave it on B) This change takes effect at the immediate next time step.

setMode

public void setMode(@Cast(value="game_mode_t")
                    int value)

Set the game mode according to the value. The new mode will not take effect until reset() is called

isTerminal

@Cast(value="bool")
public boolean isTerminal()

Returns true once we reach a terminal state

setState

public void setState(@Const @ByRef
                     ALEState state)

Accessor methods for the environment state.

getState

@Const
 @ByRef
public ALEState getState()

getScreen

@Const
 @ByRef
public ALEScreen getScreen()

Returns the current screen after processing (e.g. colour averaging)

getRAM

@Const
 @ByRef
public ALERAM getRAM()

getFrameNumber

public int getFrameNumber()

getEpisodeFrameNumber

public int getEpisodeFrameNumber()

getWrapper

@Name(value="getWrapper().get")
public StellaEnvironmentWrapper getWrapper()

Returns a wrapper providing #include-free access to our methods.