- init
- close
- newEpisode
- replayEpisode
- isRunning
- isMultiplayerGame
- isRecordingEpisode
- isReplayingEpisode
- setAction
- advanceAction
- makeAction
- isNewEpisode
- isEpisodeFinished
- isPlayerDead
- respawnPlayer
- sendGameCommand
- getState
- getServerState
- getLastAction
- getEpisodeTime
- save
- load
- getAvailableButtons
- setAvailableButtons
- addAvailableButton
- clearAvailableButtons
- getAvailableButtonsSize
- setButtonMaxValue
- getButtonMaxValue
- getButton
- getAvailableGameVariables
- setAvailableGameVariables
- addAvailableGameVariable
- clearAvailableGameVariables
- getAvailableGameVariablesSize
- getGameVariable
- loadConfig
- getMode
- setMode
- getTicrate
- setTicrate
- setViZDoomPath
- setDoomGamePath
- setDoomScenarioPath
- setDoomMap
- setDoomSkill
- setDoomConfigPath
- getSeed
- setSeed
- getEpisodeStartTime
- setEpisodeStartTime
- getEpisodeTimeout
- setEpisodeTimeout
- setScreenResolution
- getScreenFormat
- setScreenFormat
- isDepthBufferEnabled
- setDepthBufferEnabled
- isLabelsBufferEnabled
- setLabelsBufferEnabled
- isAutomapBufferEnabled
- setAutomapBufferEnabled
- setAutomapMode
- setAutomapRotate
- setAutomapRenderTextures
- setRenderHud
- setRenderMinimalHud
- setRenderWeapon
- setRenderCrosshair
- setRenderDecals
- setRenderParticles
- setRenderEffectsSprites
- setRenderMessages
- setRenderCorpses
- setRenderScreenFlashes
- setRenderAllFrames
- setWindowVisible
- setConsoleEnabled
- setSoundEnabled
- getScreenWidth
- getScreenHeight
- getScreenChannels
- getScreenPitch
- getScreenSize
- isObjectsInfoEnabled
- setObjectsInfoEnabled
- isSectorsInfoEnabled
- setSectorsInfoEnabled
- isAudioBufferEnabled
- setAudioBufferEnabled
- getAudioSamplingFreq
- setAudioSamplingFreq
- getAudioBufferSize
- setAudioBufferSize
C++ | bool init() |
---|---|
Python | bool init() |
Initializes ViZDoom game instance and starts newEpisode. After calling this method, the first state from a new episode will be available. Some configuration options cannot be changed after calling this method. Init returns true when the game was started properly and false otherwise.
C++ | void close() |
---|---|
Python | void close() |
Closes ViZDoom game instance. It is automatically invoked by the destructor. The game can be initialized again after being closed.
C++ | void newEpisode(std::string recordFilePath = "") |
---|---|
Python | void new_episode(str recordFilePath = "") |
Changed in 1.1.0
Initializes a new episode. All rewards, variables and state are restarted. After calling this method, the first state from the new episode will be available. If the recordFilePath is not empty, the new episode will be recorded to this file (as a Doom lump).
In a multiplayer game, the host can call this method to finish the game. Then the rest of the players must also call this method to start a new episode.
C++ | void replayEpisode(std::string filePath, unsigned int player = 0) |
---|---|
Python | void replay_episode(str filePath, int player = 0) |
Added in 1.1.0
Replays recorded episode from the given file and using the perspective of the specified player.
Players are numbered from 1, player
equal to 0 results in replaying demo using the perspective
of default player in the recording file.
After calling this method, the first state from replay will be available.
All rewards, variables and state are available during replaying episode.
See also:
C++ | bool isRunning() |
---|---|
Python | bool is_running() |
Checks if the ViZDoom game instance is running.
C++ | bool isMultiplayerGame() |
---|---|
Python | bool is_multiplayer_game() |
Added in 1.1.2
Checks if the game is in multiplayer mode.
C++ | bool isRecordingEpisode() |
---|---|
Python | bool is_recording_episode() |
Added in 1.1.5
Checks if the game is in recording mode.
C++ | bool isReplayingEpisode() |
---|---|
Python | bool is_replaying_episode() |
Added in 1.1.5
Checks if the game is in replaying mode.
C++ | void setAction(std::vector<double> const &actions) |
---|---|
Python | void set_action(list actions) |
Sets the player's action for the next tics.
Each value corresponds to a button specified with addAvailableButton
method
or in the configuration file (in order of appearance).
C++ | void advanceAction(unsigned int tics = 1, bool updateState = true) |
---|---|
Python | void advance_action(int tics = 1, bool updateState = True) |
Processes a specified number of tics. If updateState
is set the state will be updated after last processed tic
and a new reward will be calculated. To get new state use getState
and to get the new reward use getLastReward
.
If updateState
is not set the state will not be updated.
C++ | double makeAction(std::vector<double> const &actions, unsigned int tics = 1) |
---|---|
Python | float make_action(list actions, int tics = 1) |
Method combining usability of setAction
, advanceAction
and getLastReward
.
Sets the player's action for the next tics, processes a specified number of tics,
updates the state and calculates a new reward, which is returned.
C++ | bool isNewEpisode() |
---|---|
Python | bool is_new_episode() |
Returns true if the current episode is in the initial state - the first state, no actions were performed yet.
C++ | bool isEpisodeFinished() |
---|---|
Python | bool is_episode_finished() |
Returns true if the current episode is in the terminal state (is finished).
makeAction
and advanceAction
methods will take no effect after this point (unless newEpisode
method is called).
C++ | bool isPlayerDead() |
---|---|
Python | bool is_player_dead() |
Returns true if the player is dead.
In singleplayer, player death is equivalent to the end of the episode.
In multiplayer, when the player is dead respawnPlayer
method can be called.
C++ | void respawnPlayer() |
---|---|
Python | void respawn_player() |
This method respawns the player after death in multiplayer mode. After calling this method, the first state after the respawn will be available.
See also:
C++ | void sendGameCommand(std::string cmd) |
---|---|
Python | void send_game_command(str cmd) |
Sends the command to Doom console. It can be used for controlling the game, changing settings, cheats, etc. Some commands will be blocked in some modes.
See also:
C++ | GameStatePtr (std::shared_ptr<GameState>) GameState getState() |
---|---|
Python | GameState get_state() |
Changed in 1.1.0
Returns GameState
object with the current game state.
If the current episode is finished, nullptr/null/None
will be returned.
See also:
C++ | ServerStatePtr (std::shared_ptr<ServerState>) ServerState getServerState() |
---|---|
Python | ServerState get_state_state() |
Added in 1.1.6
Returns ServerState
object with the current server state.
See also:
C++ | std::vector<double> getLastAction() |
---|---|
Python | list get_last_action() |
Returns the last action performed.
Each value corresponds to a button added with [addAvailableButton](#addAvailableButton)
(in order of appearance).
Most useful in SPECTATOR
mode.
C++ | unsigned int getEpisodeTime() |
---|---|
Python | int get_episode_time() |
Returns number of current episode tic.
C++ | void save(std::string filePath) |
---|---|
Python | void save(str filePath) |
Added in 1.1.9
Saves current game state to the file.
C++ | void load(std::string filePath) |
---|---|
Python | void load(str filePath) |
Added in 1.1.9
Loads game state from the file. A new state is available after loading. Loading the game state does not reset the current episode state, tic counter/time and total reward state keep their values.
C++ | std::vector<Button> getAvailableButtons() |
---|---|
Python | list get_available_buttons() |
Returns the list of available Buttons
.
See also:
C++ | void setAvailableButtons(std::vector<Button> buttons) |
---|---|
Python | void add_available_button(list) |
Set given list of Button
s (e.g. TURN_LEFT
, MOVE_FORWARD
) as available Buttons
,
Config key: availableButtons/available_buttons
(list)
See also:
C++ | void addAvailableButton(Button button, double maxValue = 0) |
---|---|
Python | void add_available_button(Button button, float maxValue = 0) |
Add Button
type (e.g. TURN_LEFT
, MOVE_FORWARD
) to available Buttons
and sets the maximum allowed, absolute value for the specified button.
If the given button has already been added, it will not be added again, but the maximum value is overridden.
Config key: availableButtons/available_buttons
(list)
See also:
C++ | void clearAvailableButtons() |
---|---|
Python | void clear_available_buttons() |
Clears all available Buttons
added so far.
See also:
C++ | int getAvailableButtonsSize() |
---|---|
Python | int get_available_buttons_size() |
Returns the number of available Buttons
.
See also:
C++ | void setButtonMaxValue(Button button, double maxValue = 0) |
---|---|
Python | void set_button_max_value(Button button, float maxValue = 0) |
Sets the maximum allowed, absolute value for the specified button. Setting the maximum value to 0 results in no constraint at all (infinity). This method makes sense only for delta buttons. Constraints limit applies in all Modes.
See also:
C++ | unsigned int getButtonMaxValue(Button button) |
---|---|
Python | int get_button_max_value(Button button) |
Returns the maximum allowed, absolute value for the specified button.
See also:
C++ | double getButton(Button button) |
---|---|
Python | float get_button(Button button) |
Returns the current state of the specified button (ATTACK
, USE
etc.).
See also:
C++ | std::vector<GameVariable> getAvailableGameVariables() |
---|---|
Python | list get_available_game_variables() |
Returns the list of available GameVariables
.
See also:
C++ | void setAvailableGameVariables(std::vector<GameVariable> variables) |
---|---|
Python | void set_available_game_variables(list variables) |
Set list of GameVariable
as available GameVariables
in the GameState
returned by getState
method.
Config key: availableGameVariables/available_game_variables
(list)
See also:
C++ | void addAvailableGameVariable(GameVariable variable) |
---|---|
Python | void add_available_game_variable(GameVariable variable) |
Adds the specified GameVariable
to the list of available game variables (e.g. HEALTH
, AMMO1
, ATTACK_READY
) in the GameState
returned by getState
method.
Config key: availableGameVariables/available_game_variables
(list)
See also:
C++ | void clearAvailableGameVariables() |
---|---|
Python | void clear_available_game_variables() |
Clears the list of available GameVariables
that are included in the GameState returned by getState
method.
See also:
C++ | unsigned int getAvailableGameVariablesSize() |
---|---|
Python | int get_available_game_variables_size() |
Returns the number of available GameVariables
.
See also:
C++ | double getGameVariable(GameVariable variable) |
---|---|
Python | float get_game_variable(GameVariable variable) |
Returns the current value of the specified game variable (HEALTH
, AMMO1
etc.).
The specified game variable does not need to be among available game variables (included in the state).
It could be used for e.g. shaping. Returns 0 in case of not finding given GameVariable
.
See also:
C++ | void addGameArgs(std::string args) |
---|---|
Python | void add_game_args(str args) |
Adds a custom argument that will be passed to ViZDoom process during initialization. Useful for changing additional game settings.
Config key: gameArgs/game_args
See also:
C++ | void clearGameArgs() |
---|---|
Python | void clear_game_args() |
Clears all arguments previously added with addGameArgs
method.
C++ | double getLivingReward() |
---|---|
Python | double get_living_reward() |
Returns the reward granted to the player after every tic.
C++ | void setLivingReward(double livingReward) |
---|---|
Python | void set_living_reward(float livingReward) |
Sets the reward granted to the player after every tic. A negative value is also allowed.
Default value: 0
Config key: livingReward/living_reward
C++ | double getDeathPenalty() |
---|---|
Python | double get_death_penalty() |
Returns the penalty for player's death.
C++ | void setDeathPenalty(double deathPenalty) |
---|---|
Python | void set_death_penalty(float deathPenalty) |
Sets a penalty for player's death. Note that in case of a negative value, the player will be rewarded upon dying.
Default value: 0
Config key: deathPenalty/death_penalty
C++ | double getLastReward() |
---|---|
Python | float get_last_reward() |
Returns a reward granted after the last update of state.
C++ | double getTotalReward() |
---|---|
Python | float get_total_reward() |
Returns the sum of all rewards gathered in the current episode.
C++ | bool loadConfig(std::string filePath) |
---|---|
Python | bool load_config(str filePath) |
Loads configuration (resolution, available buttons, game variables etc.) from a configuration file. In case of multiple invocations, older configurations will be overwritten by the recent ones. Overwriting does not involve resetting to default values. Thus only overlapping parameters will be changed. The method returns true if the whole configuration file was correctly read and applied, false if the file contained errors.
See also:
C++ | Mode getMode() |
---|---|
Python | Mode get_mode() |
Returns current mode.
C++ | void setMode(Mode mode) |
---|---|
Python | void set_mode(Mode mode) |
Sets mode (PLAYER
, SPECTATOR
, ASYNC_PLAYER
, ASYNC_SPECTATOR
) in which the game will be running.
Default value: PLAYER
.
Config key: mode
See also:
C++ | unsigned int getTicrate() |
---|---|
Python | int get_ticrate() |
Added in 1.1.0
Returns current ticrate.
C++ | void setTicrate(unsigned int ticrate) |
---|---|
Python | void set_ticrate(int ticrate) |
Added in 1.1.0
Sets ticrate for ASNYC Modes - number of logic tics executed per second. Default Doom ticrate is 35. This value will play a game at normal speed.
Default value: 35 (default Doom ticrate).
Config key: ticrate
See also:
C++ | void setViZDoomPath(std::string filePath) |
---|---|
Python | void set_vizdoom_path(str filePath) |
Sets path to ViZDoom engine executable.
Default value: "$VIZDOOM.SO_LOCATION/vizdoom", "vizdoom.exe" on Windows.
Config key: ViZDoomPath/vizdoom_path
C++ | void setDoomGamePath(std::string filePath) |
---|---|
Python | void set_doom_game_path(str filePath) |
Sets path to the Doom engine based game file (wad format). If not used DoomGame will look for doom2.wad and freedoom2.wad (in that order) in the directory of ViZDoom's installation (where vizdoom.so is).
Default value: "$VIZDOOM.SO_LOCATION/{doom2.wad or freedoom2.wad}"
Config key: DoomGamePath/doom_game_path
C++ | void setDoomScenarioPath(std::string filePath) |
---|---|
Python | void set_doom_scenario_path(str filePath) |
Sets path to additional scenario file (wad format).
Default value: ""
Config key: DoomScenarioPath/set_doom_scenario_path
C++ | void setDoomMap(std::string map) |
---|---|
Python | void set_doom_map(str map) |
Sets the map name to be used.
Default value: "map01", if set to empty "map01" will be used.
Config key: DoomMap/doom_map
C++ | void setDoomSkill(int skill) |
---|---|
Python | void set_doom_skill(int skill) |
Sets Doom game difficulty level which is called skill in Doom. The higher is the skill, the harder the game becomes. Skill level affects monsters' aggressiveness, monsters' speed, weapon damage, ammunition quantities etc. Takes effect from the next episode.
- 1 - VERY EASY, “I'm Too Young to Die” in Doom.
- 2 - EASY, “Hey, Not Too Rough" in Doom.
- 3 - NORMAL, “Hurt Me Plenty” in Doom.
- 4 - HARD, “Ultra-Violence” in Doom.
- 5 - VERY HARD, “Nightmare!” in Doom.
Default value: 3
Config key: DoomSkill/doom_skill
C++ | void setDoomConfigPath(std::string filePath) |
---|---|
Python | void set_doom_config_path(str filePath) |
Sets path for ViZDoom engine configuration file. The file is responsible for configuration of Doom engine itself. If it does not exist, it will be created after vizdoom executable is run. This method is not needed for most of the tasks and is added for convenience of users with hacking tendencies.
Default value: "", if left empty "_vizdoom.ini" will be used.
Config key: DoomConfigPath/doom_config_path
C++ | unsigned int getSeed() |
---|---|
Python | int getSeed() |
Return ViZDoom's seed.
C++ | void setSeed(unsigned int seed) |
---|---|
Python | void set_seed(int seed) |
Sets the seed of the ViZDoom's RNG that generates seeds (initial state) for episodes.
Default value: randomized in constructor
Config key: seed
See also:
C++ | unsigned int getEpisodeStartTime() |
---|---|
Python | int get_episode_start_time() |
Returns start delay of every episode in tics.
C++ | void setEpisodeStartTime(unsigned int tics) |
---|---|
Python | void set_episode_start_time(int tics) |
Sets start delay of every episode in tics. Every episode will effectively start (from the user's perspective) after given number of tics.
Default value: 1
Config key: episodeStartTime/episode_start_time
C++ | unsigned int getEpisodeTimeout() |
---|---|
Python | int get_episode_timeout() |
Returns the number of tics after which the episode will be finished.
C++ | void setEpisodeTimeout(unsigned int tics) |
---|---|
Python | void set_episode_timeout(int tics) |
Sets the number of tics after which the episode will be finished. 0 will result in no timeout.
Config key: episodeTimeout/episode_timeout
C++ | void setScreenResolution(ScreenResolution resolution) |
---|---|
Python | void set_screen_resolution(ScreenResolution resolution) |
Sets the screen resolution. ZDoom engine supports only specific resolutions,
supported resolutions are part of ScreenResolution enumeration (e.g. RES_320X240
, RES_640X480
, RES_1920X1080
).
The buffers, as well as the content of ViZDoom's display window, will be affected.
Default value: RES_320X240
Config key: screenResolution/screen_resolution
See also:
C++ | ScreenFormat getScreenFormat() |
---|---|
Python | ScreenFormat get_screen_format() |
Returns the format of the screen buffer and the automap buffer.
C++ | void setScreenFormat(ScreenFormat format) |
---|---|
Python | void set_screen_format(ScreenFormat format) |
Sets the format of the screen buffer and the automap buffer.
Supported formats are defined in ScreenFormat
enumeration type (e.g. CRCGCB
, RGB24
, GRAY8
).
The format change affects only the buffers, so it will not have any effect on the content of ViZDoom's display window.
Default value: CRCGCB
Config key: screenFormat/screen_format
See also:
C++ | bool isDepthBufferEnabled() |
---|---|
Python | bool isDepthBufferEnabled() |
Added in 1.1.0
Returns true if the depth buffer is enabled.
C++ | void setDepthBufferEnabled(bool depthBuffer) |
---|---|
Python | void set_depth_buffer_enabled(bool depthBuffer) |
Added in 1.1.0
Enables rendering of the depth buffer, it will be available in the state.
Depth buffer will contain noise if viz_nocheat
is enabled.
Default value: false
Config key: depthBufferEnabled/depth_buffer_enabled
See also:
C++ | bool isLabelsBufferEnabled() |
---|---|
Python | bool isLabelsBufferEnabled() |
Added in 1.1.0
Returns true if the labels buffer is enabled.
C++ | void setLabelsBufferEnabled(bool labelsBuffer) |
---|---|
Python | void set_labels_buffer_enabled(bool labelsBuffer) |
Added in 1.1.0
Enables rendering of the labels buffer, it will be available in the state with the vector of Label
s.
LabelsBuffer will contain noise if viz_nocheat
is enabled.
Default value: false
Config key: labelsBufferEnabled/labels_buffer_enabled
See also:
C++ | bool isAutomapBufferEnabled() |
---|---|
Python | bool is_automap_buffer_enabled() |
Added in 1.1.0
Returns true if the automap buffer is enabled.
C++ | void setAutomapBufferEnabled(bool automapBuffer) |
---|---|
Python | void set_automap_buffer_enabled(bool automapBuffer) |
Added in 1.1.0
Enables rendering of the automap buffer, it will be available in the state.
Default value: false
Config key: automapBufferEnabled/automap_buffer_enabled
See also:
C++ | void setAutomapMode(AutomapMode mode) |
---|---|
Python | void set_automap_mode(AutomapMode mode) |
Added in 1.1.0
Sets the automap mode (NORMAL
, WHOLE
, OBJECTS
, OBJECTS_WITH_SIZE
), which determines what will be visible on it.
Default value: NORMAL
Config key: automapMode/set_automap_mode
See also:
C++ | void setAutomapRotate(bool rotate) |
---|---|
Python | void set_automap_rotate(bool rotate) |
Added in 1.1.0
Determine if the automap will be rotating with the player. If false, north always will be at the top of the buffer.
Default value: false
Config key: automapRotate/automap_rotate
C++ | void setAutomapRenderTextures(bool textures) |
---|---|
Python | void set_automap_render_textures(bool textures) |
Added in 1.1.0
Determine if the automap will be textured, showing the floor textures.
Default value: true
Config key: automapRenderTextures/automap_render_textures
C++ | void setRenderHud(bool hud) |
---|---|
Python | void set_render_hud(bool hud) |
Determine if the hud will be rendered in game.
Default value: false
Config key: renderHud/render_hud
C++ | void setRenderMinimalHud(bool minHud) |
---|---|
Python | void set_render_minimal_hud(bool minHud) |
Added in 1.1.0
Determine if the minimalistic version of the hud will be rendered instead of the full hud.
Default value: false
Config key: renderMinimalHud/render_minimal_hud
C++ | void setRenderWeapon(bool weapon) |
---|---|
Python | void set_render_weapon(bool weapon) |
Determine if the weapon held by the player will be rendered in game.
Default value: true
Config key: renderWeapon/render_weapon
C++ | void setRenderCrosshair(bool crosshair) |
---|---|
Python | void set_render_crosshair(bool crosshair) |
Determine if the crosshair will be rendered in game.
Default value: false
Config key: renderCrosshair/render_crosshair
C++ | void setRenderDecals(bool decals) |
---|---|
Python | void set_render_decals(bool decals) |
Determine if the decals (marks on the walls) will be rendered in game.
Default value: true
Config key: renderDecals/render_decals
C++ | void setRenderParticles(bool particles) |
---|---|
Python | void set_render_particles(bool particles) |
Determine if the particles will be rendered in game.
Default value: true
Config key: renderParticles/render_particles
C++ | void setRenderEffectsSprites(bool sprites) |
---|---|
Python | void set_render_effects_sprites(bool sprites) |
Added in 1.1.0
Determine if some effects sprites (gun puffs, blood splats etc.) will be rendered in game.
Default value: true
Config key: renderEffectsSprites/render_effects_sprites
C++ | void setRenderMessages(bool messages) |
---|---|
Python | void set_render_messages(bool messages) |
Added in 1.1.0
Determine if ingame messages (information about pickups, kills etc.) will be rendered in game.
Default value: false
Config key: renderMessages/render_messages
C++ | void setRenderCorpses(bool corpses) |
---|---|
Python | void set_render_corpsess(bool corpses) |
Added in 1.1.0
Determine if actors' corpses will be rendered in game.
Default value: true
Config key: renderCorpses/render_corpses
C++ | void setRenderScreenFlashes(bool flashes) |
---|---|
Python | void set_render_screen_flashes(bool flashes) |
Added in 1.1.3
Determine if the screen flash effect upon taking damage or picking up items will be rendered in game.
Default value: true
Config key: renderScreenFlashes/render_screen_flashes
C++ | void setRenderAllFrames(bool allFrames) |
---|---|
Python | void set_render_all_frames(bool all_frames) |
Added in 1.1.3
Determine if all frames between states will be rendered (when skip greater than 1 is used). Allows smooth preview but can reduce performance. It only makes sense to use it if the window is visible.
Default value: false
Config key: renderAllFrames/render_all_frames
See also:
C++ | void setWindowVisible(bool visibility) |
---|---|
Python | void set_window_visible(bool visibility) |
Determines if ViZDoom's window will be visible. ViZDoom with window disabled can be used on Linux systems without X Server.
Default value: false
Config key: windowVisible/window_visible
C++ | void setConsoleEnabled(bool console) |
---|---|
Python | void set_console_enabled(bool console) |
Determines if ViZDoom's console output will be enabled.
Default value: false
Config key: consoleEnabled/console_enabled
C++ | void setSoundEnabled(bool sound) |
---|---|
Python | void set_sound_enabled(bool sound) |
Determines if ViZDoom's sound will be played.
Default value: false
Config key: soundEnabled/sound_enabled
C++ | int getScreenWidth() |
---|---|
Python | int get_screen_width() |
Returns game's screen width - width of all buffers.
C++ | int getScreenHeight() |
---|---|
Python | int get_screen_height() |
Returns game's screen height - height of all buffers.
C++ | int getScreenChannels() |
---|---|
Python | int get_screen_channels() |
Returns number of channels in screen buffer and map buffer (depth and labels buffer always have one channel).
C++ | size_t getScreenPitch() |
---|---|
Python | int get_screen_pitch() |
Returns size in bytes of one row in screen buffer and map buffer.
C++ | size_t getScreenSize() |
---|---|
Python | int get_screen_size() |
Returns size in bytes of screen buffer and map buffer.
C++ | bool isAutomapBufferEnabled() |
---|---|
Python | bool isAutomapBufferEnabled() |
Added in 1.1.8
Returns true if the objects information is enabled.
C++ | void setObjectsInfoEnabled(bool objectsInfo) |
---|---|
Python | void set_objects_info_enabled(bool objectsInfo) |
Added in 1.1.8
Enables information about all objects present in current episode/level, it will be available in the state.
Default value: false
Config key: objectsInfoEnabled/objects_info_enabled
See also:
C++ | bool isSectorsInfoEnabled() |
---|---|
Python | bool is_sectors_info_enabled() |
Added in 1.1.8
Returns true if the sectors information is enabled.
C++ | void setSectorsInfoEnabled(bool sectorsInfo) |
---|---|
Python | void set_sectors_info_enabled(bool sectorsInfo) |
Added in 1.1.8
Enables information about all sectors (map layout) present in current episode/level, it will be available in the state.
Default value: false
Config key: sectorsInfoEnabled/sectors_info_enabled
See also:
C++ | bool isAudioBufferEnabled() |
---|---|
Python | bool is_audio_buffer_enabled() |
Added in 1.1.9
Returns true if the audio buffer is enabled.
C++ | void setAudioBufferEnabled(bool audioBuffer) |
---|---|
Python | void set_audio_buffer_enabled(bool audioBuffer) |
Added in 1.1.9
Returns true if the audio buffer is enabled.
Default value: false
Config key: audioBufferEnabled/audio_buffer_enabled
See also:
C++ | SamplingRate getAudioSamplingRate() |
---|---|
Python | SamplingRate get_audio_sampling_rate() |
Added in 1.1.9
Returns the sampling rate of audio buffer.
See also:
C++ | void setAudioSamplingRate(SamplingRate samplingRate) |
---|---|
Python | void set_audio_sampling_rate(SamplingRate samplingRate) |
Added in 1.1.9
Sets the sampling rate of audio buffer.
Default value: false
Config key: audioSamplingRate/audio_samping_rate
See also:
C++ | int getAudioBufferSize() |
---|---|
Python | int get_audio_buffer_size() |
Added in 1.1.9
Returns the size of audio buffer.
See also:
C++ | void setAudioBufferSize(int size) |
---|---|
Python | void set_audio_buffer_size(int size) |
Added in 1.1.9
Sets the size of audio buffer. Size is defined in number of logic tics. After each action audio buffer will contain audio from specified number of last processed tics. Doom uses 35 ticks per second.
Default value: 4
Config key: audioBufferSize/audio_buffer_size
See also: