gameboy_worlds.interface.bomberman.environments

View Source

 1from gameboy_worlds.emulation.bomberman.trackers import (
 2    BombermanMaxTracker,
 3    BombermanPocketTracker,
 4    BombermanQuestTracker,
 5)
 6from gameboy_worlds.emulation.emulator import Emulator
 7from gameboy_worlds.interface.environment import DummyEnvironment, TestEnvironmentMixin
 8
 9
10class BombermanMaxEnvironment(DummyEnvironment):
11    REQUIRED_EMULATOR = Emulator
12    REQUIRED_STATE_TRACKER = BombermanMaxTracker
13
14
15class BombermanPocketEnvironment(DummyEnvironment):
16    REQUIRED_EMULATOR = Emulator
17    REQUIRED_STATE_TRACKER = BombermanPocketTracker
18
19
20class BombermanQuestEnvironment(DummyEnvironment):
21    REQUIRED_EMULATOR = Emulator
22    REQUIRED_STATE_TRACKER = BombermanQuestTracker
23
24
25class BombermanMaxTestEnvironment(TestEnvironmentMixin, BombermanMaxEnvironment):
26    pass
27
28
29class BombermanPocketTestEnvironment(TestEnvironmentMixin, BombermanPocketEnvironment):
30    pass
31
32
33class BombermanQuestTestEnvironment(TestEnvironmentMixin, BombermanQuestEnvironment):
34    pass

class BombermanMaxEnvironment(typing.Generic[~ObsType, ~ActType]): View Source

11class BombermanMaxEnvironment(DummyEnvironment):
12    REQUIRED_EMULATOR = Emulator
13    REQUIRED_STATE_TRACKER = BombermanMaxTracker

A dummy environment that does nothing special.

REQUIRED_EMULATOR = <class 'gameboy_worlds.emulation.emulator.Emulator'>

The highest level emulator that the environment can interface with.

REQUIRED_STATE_TRACKER = <class 'gameboy_worlds.emulation.bomberman.trackers.BombermanMaxTracker'>

The state tracker that tracks the minimal state information required for the environment to function.

Inherited Members

gameboy_worlds.interface.environment.DummyEnvironment: DummyEnvironment; observation_space; get_observation; determine_reward; determine_terminated; render_obs; render_info
gameboy_worlds.interface.environment.Environment: override_emulator_kwargs; override_state_tracker_class; action_space; actions; render_mode; save_custom_state; delete_custom_state; load_custom_state; get_info; get_final_info; reset; determine_truncated; before_step; after_step; step; step_high_level_action; step_str; string_to_high_level_action; sim; sim_str; sim_high_level_action; close; render; seed; get_action_strings; human_step_play

class BombermanPocketEnvironment(typing.Generic[~ObsType, ~ActType]): View Source

16class BombermanPocketEnvironment(DummyEnvironment):
17    REQUIRED_EMULATOR = Emulator
18    REQUIRED_STATE_TRACKER = BombermanPocketTracker

A dummy environment that does nothing special.

REQUIRED_EMULATOR = <class 'gameboy_worlds.emulation.emulator.Emulator'>

The highest level emulator that the environment can interface with.

REQUIRED_STATE_TRACKER = <class 'gameboy_worlds.emulation.bomberman.trackers.BombermanPocketTracker'>

The state tracker that tracks the minimal state information required for the environment to function.

Inherited Members

gameboy_worlds.interface.environment.DummyEnvironment: DummyEnvironment; observation_space; get_observation; determine_reward; determine_terminated; render_obs; render_info
gameboy_worlds.interface.environment.Environment: override_emulator_kwargs; override_state_tracker_class; action_space; actions; render_mode; save_custom_state; delete_custom_state; load_custom_state; get_info; get_final_info; reset; determine_truncated; before_step; after_step; step; step_high_level_action; step_str; string_to_high_level_action; sim; sim_str; sim_high_level_action; close; render; seed; get_action_strings; human_step_play

class BombermanQuestEnvironment(typing.Generic[~ObsType, ~ActType]): View Source

21class BombermanQuestEnvironment(DummyEnvironment):
22    REQUIRED_EMULATOR = Emulator
23    REQUIRED_STATE_TRACKER = BombermanQuestTracker

A dummy environment that does nothing special.

REQUIRED_EMULATOR = <class 'gameboy_worlds.emulation.emulator.Emulator'>

The highest level emulator that the environment can interface with.

REQUIRED_STATE_TRACKER = <class 'gameboy_worlds.emulation.bomberman.trackers.BombermanQuestTracker'>

The state tracker that tracks the minimal state information required for the environment to function.

Inherited Members

gameboy_worlds.interface.environment.DummyEnvironment: DummyEnvironment; observation_space; get_observation; determine_reward; determine_terminated; render_obs; render_info
gameboy_worlds.interface.environment.Environment: override_emulator_kwargs; override_state_tracker_class; action_space; actions; render_mode; save_custom_state; delete_custom_state; load_custom_state; get_info; get_final_info; reset; determine_truncated; before_step; after_step; step; step_high_level_action; step_str; string_to_high_level_action; sim; sim_str; sim_high_level_action; close; render; seed; get_action_strings; human_step_play

class BombermanMaxTestEnvironment(typing.Generic[~ObsType, ~ActType]): View Source

26class BombermanMaxTestEnvironment(TestEnvironmentMixin, BombermanMaxEnvironment):
27    pass

Mixin class for testing environments. Ensures the State Tracker used is a TestTrackerMixin and checks these for termination / truncation.

Inherited Members

gameboy_worlds.interface.environment.DummyEnvironment: DummyEnvironment; observation_space; get_observation; determine_reward; render_obs; render_info
gameboy_worlds.interface.environment.TestEnvironmentMixin: REQUIRED_STATE_TRACKER; determine_truncated; determine_terminated
BombermanMaxEnvironment: REQUIRED_EMULATOR
gameboy_worlds.interface.environment.Environment: override_emulator_kwargs; override_state_tracker_class; action_space; actions; render_mode; save_custom_state; delete_custom_state; load_custom_state; get_info; get_final_info; reset; before_step; after_step; step; step_high_level_action; step_str; string_to_high_level_action; sim; sim_str; sim_high_level_action; close; render; seed; get_action_strings; human_step_play

class BombermanPocketTestEnvironment(typing.Generic[~ObsType, ~ActType]): View Source

30class BombermanPocketTestEnvironment(TestEnvironmentMixin, BombermanPocketEnvironment):
31    pass

Mixin class for testing environments. Ensures the State Tracker used is a TestTrackerMixin and checks these for termination / truncation.

Inherited Members

gameboy_worlds.interface.environment.DummyEnvironment: DummyEnvironment; observation_space; get_observation; determine_reward; render_obs; render_info
gameboy_worlds.interface.environment.TestEnvironmentMixin: REQUIRED_STATE_TRACKER; determine_truncated; determine_terminated
BombermanPocketEnvironment: REQUIRED_EMULATOR
gameboy_worlds.interface.environment.Environment: override_emulator_kwargs; override_state_tracker_class; action_space; actions; render_mode; save_custom_state; delete_custom_state; load_custom_state; get_info; get_final_info; reset; before_step; after_step; step; step_high_level_action; step_str; string_to_high_level_action; sim; sim_str; sim_high_level_action; close; render; seed; get_action_strings; human_step_play

class BombermanQuestTestEnvironment(typing.Generic[~ObsType, ~ActType]): View Source

34class BombermanQuestTestEnvironment(TestEnvironmentMixin, BombermanQuestEnvironment):
35    pass

Mixin class for testing environments. Ensures the State Tracker used is a TestTrackerMixin and checks these for termination / truncation.

Inherited Members

gameboy_worlds.interface.environment.DummyEnvironment: DummyEnvironment; observation_space; get_observation; determine_reward; render_obs; render_info
gameboy_worlds.interface.environment.TestEnvironmentMixin: REQUIRED_STATE_TRACKER; determine_truncated; determine_terminated
BombermanQuestEnvironment: REQUIRED_EMULATOR
gameboy_worlds.interface.environment.Environment: override_emulator_kwargs; override_state_tracker_class; action_space; actions; render_mode; save_custom_state; delete_custom_state; load_custom_state; get_info; get_final_info; reset; before_step; after_step; step; step_high_level_action; step_str; string_to_high_level_action; sim; sim_str; sim_high_level_action; close; render; seed; get_action_strings; human_step_play