ALEx v0.3.2 Alex.Interface View Source

t() :: %Alex.Interface{
  difficulties: MapSet.t(integer()),
  difficulty: integer(),
  display_screen: boolean(),
  episode_frame: integer(),
  frame: integer(),
  legal_actions: MapSet.t(integer()),
  lives: integer(),
  minimal_actions: MapSet.t(integer()),
  mode: integer(),
  modes: MapSet.t(integer()),
  ram: Alex.RAM.t(),
  random_seed: integer(),
  ref: reference(),
  reward: number(),
  rom: String.t(),
  screen: Alex.Screen.t(),
  sound: boolean(),
  state: Alex.State.t()
}

Abstraction around ALE Interface.

The Interface struct contains all relevant information about the current ALE Interface. You should interact with this through the Alex module if you don't want to worry about interacting with the ALE reference.

Fields

:ref: Reference to ALE.
:rom: Path to loaded ROM.
:display_screen: Display screen option.
:random_seed: ALE random seed.
:sound: Play sound option.
:modes: Available game modes.
:mode: Current game mode.
:difficultues: Available difficultues.
:difficulty: Current difficulty.
:legal_actions: Current legal action set.
:minimal_actions: Current minimal action set.
:lives: Current number of lives.
:frame: Current frame number.
:episode_frame: Current episode frame number.
:screen: Current screen.
:state: Current state.
:ram: Current RAM.
:reward: Current score.

Link to this section Functions

act(ref, act)

NIF. Performs specified action.

Returns {:ok, reward}.

Parameters

ref: Reference to ALE.
action: Integer action.

ale_new()

NIF. Creates a new ALE interface.

Returns {:ok, #Reference<>}.

clone_state(ref)

NIF. Returns the current state reference.

Returns {:ok, state}.

Parameters

ref: Reference to ALE.

clone_system_state(ref)

NIF. Returns the current system state reference.

Not really sure what this does...

Returns {:ok, state}.

Parameters

ref: Reference to ALE.

decode_state(serial, len)

NIF. Decodes serialized state.

Returns {:ok, state}.

Parameters

state: serialized state.
len: length of serialized state.

encode_state(state)

NIF. Serializes the state reference.

Returns {:ok, encoded}.

Parameters

state: Reference to state.

encode_state_len(state)

NIF. Returns length of encoded state.

Returns {:ok, length}.

Parameters

state: Reference to state.

game_over(ref)

NIF. Determines if the game is over.

Returns {:ok, result}.

Parameters

ref: Reference to ALE.

get_available_difficulties(ref)

NIF. Gets available game difficulties.

Returns {:ok, [...]}.

Parameters

ref: Reference to ALE.

get_available_difficulties_size(ref)

NIF. Gets number of available difficulties.

Returns {:ok, result}.

Parameters

ref: Reference to ALE.

get_available_modes(ref)

NIF. Gets available game modes.

Returns {:ok, [...]}.

Parameters

ref: Reference to ALE.

get_available_modes_size(ref)

NIF. Gets number of available game modes.

Returns {:ok, result}.

Parameters

ref: Reference to ALE.

get_bool(ref, key)

NIF. Get boolean setting by key.

Returns {:ok, result}.

Parameters

ref: Reference to ALE.
key: String key.

get_difficulty(ref)

NIF. Gets current difficulty.

Returns {:ok, difficulty}.

Parameters

ref: Reference to ALE.

get_episode_frame_number(ref)

NIF. Gets the current episode frame number.

Returns {:ok, result}.

Parameters

ref: Reference to ALE.

get_float(ref, key)

NIF. Get float setting by key.

Returns {:ok, result}.

Parameters

ref: Reference to ALE.
key: String key.

get_frame_number(ref)

NIF. Gets the current frame number.

Returns {:ok, result}.

Parameters

ref: Reference to ALE.

get_int(ref, key)

NIF. Get integer setting by key.

Returns {:ok, result}.

Parameters

ref: Reference to ALE.
key: String key.

get_legal_action_set(ref)

NIF. Gets the current legal action set.

Returns {:ok, [...]}.

Parameters

ref: Reference to ALE.

get_legal_action_set_size(ref)

NIF. Gets the number of current legal actions.

Returns {:ok, result}.

Parameters

ref: Reference to ALE.

get_minimal_action_set(ref)

NIF. Gets the minimal action set.

Returns {:ok, [...]}.

Parameters

ref: Reference to ALE.

get_minimal_action_set_size(ref)

NIF. Gets the number of current minimal actions.

Returns {:ok, result}.

Parameters

ref: Reference to ALE.

get_ram(ref)

NIF. Gets the current RAM.

Returns {:ok, result}.

Parameters

ref: Reference to ALE.

get_ram_size(ref)

NIF. Gets the current RAM size.

Returns {:ok, result}.

Parameters

ref: Reference to ALE.

get_screen(ref)

NIF. Gets the current screen.

Returns {:ok, result}.

Parameters

ref: Reference to ALE.

get_screen_grayscale(ref)

NIF. Gets the current screen in grayscale format.

Returns {:ok, result}.

Parameters

ref: Reference to ALE.

get_screen_height(ref)

NIF. Gets the current screen height.

Returns {:ok, result}.

Parameters

ref: Reference to ALE.

get_screen_rgb(ref)

NIF. Gets the current screen in RGB format.

Returns {:ok, result}.

Parameters

ref: Reference to ALE.

get_screen_width(ref)

NIF. Gets the current screen width.

Returns {:ok, result}.

Parameters

ref: Reference to ALE.

get_string(ref, key)

NIF. Get string setting by key.

Returns {:ok, result}.

Parameters

ref: Reference to ALE.
key: String key.

lives(ref)

NIF. Gets the current number of lives.

Returns {:ok, result}.

Parameters

ref: Reference to ALE.

load_rom(ref, path)

NIF. Loads the specified ROM file.

Returns :ok.

Parameters

ref: Reference to ALE.
path: Path to ROM file.

load_state(ref)

NIF. Loads the current state.

Not really sure what this does...

Returns :ok.

Parameters

ref: Reference to ALE.

reset_game(ref)

NIF. Resets the game.

Returns :ok.

Parameters

ref: Reference to ALE.

restore_state(ref, state)

NIF. Restores the interface to specified state.

Returns {:ok, state}.

Parameters

ref: Reference to ALE.

restore_system_state(ref, state)

NIF. Restores the interface to specified system state.

Not really sure what this does...

Returns :ok.

Parameters

ref: Reference to ALE.

save_screen_png(ref, path)

NIF. Saves the current screen as png to path.

Returns :ok.

Parameters

ref: Reference to ALE
path: Path to save.

save_state(ref)

NIF. Saves the current state.

Not really sure what this does...

Returns :ok.

Parameters

ref: Reference to ALE.

set_bool(ref, key, val)

NIF. Sets key to boolean val.

Returns :ok.

Parameters

ref: Reference to ALE.
key: String key.
val: Boolean value.

set_difficulty(ref, diff)

NIF. Sets the difficulty of game.

Returns :ok.

Parameters

ref: Reference to ALE.
difficulty: Integer difficulty.

set_float(ref, key, val)

NIF. Sets key to float val.

Returns :ok.

Parameters

ref: Reference to ALE.
key: String key.
val: Float value.

set_int(ref, key, val)

NIF. Sets key to integer val.

Returns :ok.

Parameters

ref: Reference to ALE.
key: String key.
val: Integer value.

set_logger_mode(mode)

NIF. Sets mode of ALE logger.

Returns :ok.

Parameters

mode: 0, 1, or 2.

set_mode(ref, mode)

NIF. Sets the game mode.

Returns :ok.

Parameters

ref: Reference to ALE.
mode: Integer game mode.

set_string(ref, key, val)

NIF. Sets key to string val.

Returns :ok.

Parameters

ref: Reference to ALE.
key: String key.
val: String value.