diff --git a/doc/DoomGame.md b/doc/DoomGame.md index af6b256b5..223792cbf 100644 --- a/doc/DoomGame.md +++ b/doc/DoomGame.md @@ -5,11 +5,11 @@ ### `init` -| C++ | `bool init()` | -| :-- | :-- | -| Lua | `boolean init()` | -| Java | `boolean init()` | -| Python | `bool init()` | +| C++ | `bool init()` | +| :-- | :-- | +| Lua | `boolean init()` | +| Java | `boolean init()` | +| Python | `bool init()` | Initializes ViZDoom game instance and starts newEpisode. After calling this method, first state from new episode will be available. @@ -19,10 +19,10 @@ Init returns true when the game was started properly and false otherwise. ### `close` -| C++ | `void close()` | -| :-- | :-- | -| Lua | `void close()` | -| Java | `void close()` | +| C++ | `void close()` | +| :-- | :-- | +| Lua | `void close()` | +| Java | `void close()` | | Python | `void close()` | Closes ViZDoom game instance. @@ -32,11 +32,11 @@ Game can be initialized again after being closed. ### `newEpisode` -| C++ | `void newEpisode(std::string filePath = "")` | -| :-- | :-- | -| Lua | `void newEpisode(string filePath = "")` | -| Java | `void newEpisode(String filePath = "")` | -| Python | `void new_episode(str filePath = "")` | +| C++ | `void newEpisode(std::string filePath = "")` | +| :-- | :-- | +| Lua | `void newEpisode(string filePath = "")` | +| Java | `void newEpisode(String filePath = "")` | +| Python | `void new_episode(str filePath = "")` | Changed in 1.1 @@ -50,11 +50,11 @@ Then the rest of the players must also call this method to start a new episode. ### `replayEpisode` -| C++ | `void replayEpisode(std::string filePath, unsigned int player = 0)` | -| :-- | :-- | -| Lua | `void replayEpisode(string filePath, number player = 0)` | -| Java | `void replayEpisode(String filePath, unsigned int player = 0)` | -| Python | `void replay_episode(str filePath, int player = 0)` | +| C++ | `void replayEpisode(std::string filePath, unsigned int player = 0)` | +| :-- | :-- | +| Lua | `void replayEpisode(string filePath, number player = 0)` | +| Java | `void replayEpisode(String filePath, unsigned int player = 0)` | +| Python | `void replay_episode(str filePath, int player = 0)` | Added in 1.1 @@ -71,22 +71,22 @@ See also: ### `isRunning` -| C++ | `bool isRunning()` | -| :-- | :-- | -| Lua | `boolean isRunning()` | -| Java | `boolean isRunning()` | -| Python | `bool is_running()` | +| C++ | `bool isRunning()` | +| :-- | :-- | +| Lua | `boolean isRunning()` | +| Java | `boolean isRunning()` | +| Python | `bool is_running()` | Checks if the ViZDoom game instance is running. ### `setAction` -| C++ | `void setAction(std::vector const &actions)` | -| :-- | :-- | -| Lua | `void setAction(table actions)` | -| Java | `void setAction(int[] actions)` | -| Python | `void set_action(list actions)` | +| C++ | `void setAction(std::vector const &actions)` | +| :-- | :-- | +| Lua | `void setAction(table actions)` | +| Java | `void setAction(int[] 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 @@ -95,11 +95,11 @@ or in configuration file (in order of appearance). ### `advanceAction` -| C++ | `void advanceAction(unsigned int tics = 1, bool updateState = true, bool renderOnly = false)` | -| :-- | :-- | -| Lua | `void advanceAction(number tics = 1, boolean updateState = true, boolean renderOnly = false)` | -| Java | `void advanceAction(unsigned int tics = 1, boolean updateState = true, boolean renderOnly = false)` | -| Python | `void advance_action(int tics = 1, bool updateState = True, bool renderOnly = False)` | +| C++ | `void advanceAction(unsigned int tics = 1, bool updateState = true, bool renderOnly = false)` | +| :-- | :-- | +| Lua | `void advanceAction(number tics = 1, boolean updateState = true, boolean renderOnly = false)` | +| Java | `void advanceAction(unsigned int tics = 1, boolean updateState = true, boolean renderOnly = false)` | +| Python | `void advance_action(int tics = 1, bool updateState = True, bool renderOnly = False)` | 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`. @@ -109,11 +109,11 @@ will be rendered after last processed tic. ### `makeAction` -| C++ | `double makeAction(std::vector const &actions, unsigned int tics = 1)` | -| :-- | :-- | -| Lua | `number makeAction(table actions, number tics = 1);` | -| Java | `double makeAction(int[] actions, unsigned int tics = 1);` | -| Python | `double make_action(actions, tics = 1);` | +| C++ | `double makeAction(std::vector const &actions, unsigned int tics = 1)` | +| :-- | :-- | +| Lua | `number makeAction(table actions, number tics = 1);` | +| Java | `double makeAction(int[] actions, unsigned int tics = 1);` | +| Python | `double make_action(actions, 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, @@ -122,22 +122,22 @@ updates the state and calculates a new reward, which is returned. ### `isNewEpisode` -| C++ | `bool isNewEpisode()` | -| :-- | :-- | -| Lua | `boolean isNewEpisode()` | -| Java | `boolean isNewEpisode()` | -| Python | `bool is_new_episode()` | +| C++ | `bool isNewEpisode()` | +| :-- | :-- | +| Lua | `boolean isNewEpisode()` | +| Java | `boolean isNewEpisode()` | +| Python | `bool is_new_episode()` | Returns true if the current episode is in the initial state - first state, no actions were performed yet. ### `isEpisodeFinished` -| C++ | `bool isEpisodeFinished()` | -| :-- | :-- | -| Lua | `boolean isEpisodeFinished()` | -| Java | `boolean isEpisodeFinished()` | -| Python | `bool is_episode_finished()` | +| C++ | `bool isEpisodeFinished()` | +| :-- | :-- | +| Lua | `boolean isEpisodeFinished()` | +| Java | `boolean 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). @@ -145,11 +145,11 @@ Returns true if the current episode is in the terminal state (is finished). ### `isPlayerDead` -| C++ | `bool isPlayerDead()` | -| :-- | :-- | -| Lua | `boolean isPlayerDead()` | -| Java | `boolean isPlayerDead()` | -| Python | `bool is_player_dead()` | +| C++ | `bool isPlayerDead()` | +| :-- | :-- | +| Lua | `boolean isPlayerDead()` | +| Java | `boolean isPlayerDead()` | +| Python | `bool is_player_dead()` | Returns true if the player is dead state. In singleplayer player death is equivalent to the end of the episode. @@ -158,10 +158,10 @@ In multiplayer when player is dead `respawnPlayer` can be called. ### `respawnPlayer` -| C++ | `void respawnPlayer()` | -| :-- | :-- | -| Lua | `void respawnPlayer()` | -| Java | `void respawnPlayer()` | +| C++ | `void respawnPlayer()` | +| :-- | :-- | +| Lua | `void respawnPlayer()` | +| Java | `void respawnPlayer()` | | Python | `void respawn_player()` | This method respawns player after death in multiplayer mode. @@ -170,11 +170,11 @@ After calling this method, first state after respawn will be available. ### `sendGameCommand` -| C++ | `void sendGameCommand(std::string cmd)` | -| :-- | :-- | -| Lua | `void sendGameCommand(string cmd)` | -| Java | `void sendGameCommand(String cmd)` | -| Python | `void send_game_command(cmd)` | +| C++ | `void sendGameCommand(std::string cmd)` | +| :-- | :-- | +| Lua | `void sendGameCommand(string cmd)` | +| Java | `void sendGameCommand(String cmd)` | +| Python | `void send_game_command(cmd)` | Sends the command to Doom console. Can be used for cheats, multiplayer etc. Some commands will be block in some modes. @@ -185,11 +185,11 @@ See also: ### `getState` -| C++ | `GameStatePtr (std::shared_ptr) GameState getState()` | -| :-- | :-- | -| Lua | `GameState getState()` | -| Java | `GameState getState()` | -| Python | `GameState get_state()` | +| C++ | `GameStatePtr (std::shared_ptr) GameState getState()` | +| :-- | :-- | +| Lua | `GameState getState()` | +| Java | `GameState getState()` | +| Python | `GameState get_state()` | Changed in 1.1 @@ -202,11 +202,11 @@ See also: ### `getLastAction` -| C++ | `std::vector getLastAction()` | -| :-- | :-- | -| Lua | `table getLastAction()` | -| Java | `int[] getLastAction()` | -| Python | `list get_last_action()` | +| C++ | `std::vector getLastAction()` | +| :-- | :-- | +| Lua | `table getLastAction()` | +| Java | `int[] getLastAction()` | +| Python | `list get_last_action()` | Returns the last action performed. Each value corresponds to a button added with `addAvailableButton` (in order of appearance). @@ -215,10 +215,10 @@ Most useful in `SPECTATOR` mode. ### `getEpisodeTime` -| C++ | `unsigned int getEpisodeTime()` | -| :-- | :-- | -| Lua | `unsigned int getEpisodeTime()` | -| Java | `unsigned int getEpisodeTime()` | +| C++ | `unsigned int getEpisodeTime()` | +| :-- | :-- | +| Lua | `unsigned int getEpisodeTime()` | +| Java | `unsigned int getEpisodeTime()` | | Python | `unsigned int get_episode_time()` | Returns number of current episode tic. @@ -229,11 +229,11 @@ Returns number of current episode tic. ### `addAvailableButton` -| C++ | `void addAvailableButton(Button button, unsigned int maxValue = 0)` | -| :-- | :-- | -| Lua | `void addAvailableButton(Button button, number maxValue = 0)` | -| Java | `void addAvailableButton(Button button, unsigned int maxValue = 0)` | -| Python | `void add_available_button(Button button, int maxValue = 0)` | +| C++ | `void addAvailableButton(Button button, unsigned int maxValue = 0)` | +| :-- | :-- | +| Lua | `void addAvailableButton(Button button, number maxValue = 0)` | +| Java | `void addAvailableButton(Button button, unsigned int maxValue = 0)` | +| Python | `void add_available_button(Button button, int maxValue = 0)` | Add `Button` type (e.g. `TURN_LEFT`, `MOVE_FORWARD`) to `Buttons` available in action and sets the maximum allowed, absolute value for the specified button. @@ -249,10 +249,10 @@ See also: ### `clearAvailableButtons` -| C++ | `void clearAvailableButtons()` | -| :-- | :-- | -| Lua | `void clearAvailableButtons()` | -| Java | `void clearAvailableButtons()` | +| C++ | `void clearAvailableButtons()` | +| :-- | :-- | +| Lua | `void clearAvailableButtons()` | +| Java | `void clearAvailableButtons()` | | Python | `void clear_available_buttons()` | Clears all available `Buttons` added so far. @@ -260,10 +260,10 @@ Clears all available `Buttons` added so far. ### `getAvailableButtonsSize` -| C++ | `int getAvailableButtonsSize()` | -| :-- | :-- | -| Lua | `number getAvailableButtonsSize()` | -| Java | `int getAvailableButtonsSize()` | +| C++ | `int getAvailableButtonsSize()` | +| :-- | :-- | +| Lua | `number getAvailableButtonsSize()` | +| Java | `int getAvailableButtonsSize()` | | Python | `int get_available_buttons_size()` | Returns the number of available `Buttons`. @@ -271,11 +271,11 @@ Returns the number of available `Buttons`. ### `setButtonMaxValue` -| C++ | `void setButtonMaxValue(Button button, unsigned int maxValue = 0)` | -| :-- | :-- | -| Lua | `void setButtonMaxValue(Button button, number maxValue = 0)` | -| Java | `void setButtonMaxValue(Button button, unsigned int maxValue = 0)` | -| Python | `void set_button_max_value(Button button, int maxValue = 0)` | +| C++ | `void setButtonMaxValue(Button button, unsigned int maxValue = 0)` | +| :-- | :-- | +| Lua | `void setButtonMaxValue(Button button, number maxValue = 0)` | +| Java | `void setButtonMaxValue(Button button, unsigned int maxValue = 0)` | +| Python | `void set_button_max_value(Button button, int maxValue = 0)` | Sets the maximum allowed, absolute value for the specified button. Setting maximum value equal to 0 results in no constraint at all (infinity). @@ -285,11 +285,11 @@ Constraints limit applies in all Modes. ### `getButtonMaxValue` -| C++ | `unsigned int getButtonMaxValue(Button button)` | -| :-- | :-- | -| Lua | `number getButtonMaxValue(Button button)` | -| Java | `int getButtonMaxValue(Button button)` | -| Python | `int get_button_max_value(Button button)` | +| C++ | `unsigned int getButtonMaxValue(Button button)` | +| :-- | :-- | +| Lua | `number getButtonMaxValue(Button button)` | +| Java | `int getButtonMaxValue(Button button)` | +| Python | `int get_button_max_value(Button button)` | Returns the maximum allowed, absolute value for the specified button. @@ -299,10 +299,10 @@ Returns the maximum allowed, absolute value for the specified button. ### `addAvailableGameVariable` -| C++ | `void addAvailableGameVariable(GameVariable variable)` | -| :-- | :-- | -| Lua | `void addAvailableGameVariable(GameVariable variable)` | -| Java | `void addAvailableGameVariable(GameVariable variable)` | +| C++ | `void addAvailableGameVariable(GameVariable variable)` | +| :-- | :-- | +| Lua | `void addAvailableGameVariable(GameVariable variable)` | +| Java | `void addAvailableGameVariable(GameVariable variable)` | | Python | `void add_available_game_variable(GameVariable variable)` | Adds the specified `GameVariable` to the list of game variables (e.g. `HEALTH`, `AMMO1`, `ATTACK_READY`) @@ -316,10 +316,10 @@ See also: ### `clearAvailableGameVariables` -| C++ | `void clearAvailableGameVariables()` | -| :-- | :-- | -| Lua | `void clearAvailableGameVariables()` | -| Java | `void clearAvailableGameVariables()` | +| C++ | `void clearAvailableGameVariables()` | +| :-- | :-- | +| Lua | `void clearAvailableGameVariables()` | +| Java | `void clearAvailableGameVariables()` | | Python | `void clear_available_game_variables()` | Clears the list of available `GameVariables` that are included in the GameState returned by `getState` method. @@ -327,10 +327,10 @@ Clears the list of available `GameVariables` that are included in the GameState ### `getAvailableGameVariablesSize` -| C++ | `unsigned int getAvailableGameVariablesSize()` | -| :-- | :-- | -| Lua | `number getAvailableGameVariablesSize()` | -| Java | `unsigned int getAvailableGameVariablesSize()` | +| C++ | `unsigned int getAvailableGameVariablesSize()` | +| :-- | :-- | +| Lua | `number getAvailableGameVariablesSize()` | +| Java | `unsigned int getAvailableGameVariablesSize()` | | Python | `unsigned int get_available_game_variables_size()` | Returns the number of available `GameVariables`. @@ -338,11 +338,11 @@ Returns the number of available `GameVariables`. ### `getGameVariable` -| C++ | `int getGameVariable(GameVariable variable)` | -| :-- | :-- | -| Lua | `int getGameVariable(GameVariable var)` | -| Java | `int getGameVariable(GameVariable var)` | -| Python | `int get_game_variable(GameVariable var)` | +| C++ | `int getGameVariable(GameVariable variable)` | +| :-- | :-- | +| Lua | `int getGameVariable(GameVariable var)` | +| Java | `int getGameVariable(GameVariable var)` | +| Python | `int get_game_variable(GameVariable var)` | 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). @@ -357,11 +357,11 @@ Game Arguments methods ### `addGameArgs` -| C++ | `void addGameArgs(std::string args)` | -| :-- | :-- | -| Lua | `void addGameArgs(string args)` | -| Java | `void addGameArgs(String args)` | -| Python | `void add_game_args(args)` | +| C++ | `void addGameArgs(std::string args)` | +| :-- | :-- | +| Lua | `void addGameArgs(string args)` | +| Java | `void addGameArgs(String args)` | +| Python | `void add_game_args(args)` | Adds a custom argument that will be passed to ViZDoom process during initialization. @@ -374,10 +374,10 @@ See also: ### `clearGameArgs` -| C++ | `void clearGameArgs()` | -| :-- | :-- | -| Lua | `void clearGameArgs()` | -| Java | `void clearGameArgs()` | +| C++ | `void clearGameArgs()` | +| :-- | :-- | +| Lua | `void clearGameArgs()` | +| Java | `void clearGameArgs()` | | Python | `void clear_game_args()` | Clears all arguments previously added with addGameArgs method. @@ -388,10 +388,10 @@ Clears all arguments previously added with addGameArgs method. ### `getLivingReward` -| C++ | `double getLivingReward()` | -| :-- | :-- | -| Lua | `number getLivingReward()` | -| Java | `double getLivingReward()` | +| C++ | `double getLivingReward()` | +| :-- | :-- | +| Lua | `number getLivingReward()` | +| Java | `double getLivingReward()` | | Python | `double get_living_reward()` | Returns the reward granted to the player after every tic. @@ -399,10 +399,10 @@ Returns the reward granted to the player after every tic. ### `setLivingReward` -| C++ | `void setLivingReward(double livingReward)` | -| :-- | :-- | -| Lua | `void setLivingReward(number livingReward)` | -| Java | `void setLivingReward(double livingReward)` | +| C++ | `void setLivingReward(double livingReward)` | +| :-- | :-- | +| Lua | `void setLivingReward(number livingReward)` | +| Java | `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. @@ -414,10 +414,10 @@ Config key: livingReward / living_reward ### `getDeathPenalty` -| C++ | `double getDeathPenalty()` | -| :-- | :-- | -| Lua | `double getDeathPenalty()` | -| Java | `double getDeathPenalty()` | +| C++ | `double getDeathPenalty()` | +| :-- | :-- | +| Lua | `double getDeathPenalty()` | +| Java | `double getDeathPenalty()` | | Python | `double get_death_penalty()` | Returns the penalty for player's death. @@ -425,10 +425,10 @@ Returns the penalty for player's death. ### `setDeathPenalty` -| C++ | `void setDeathPenalty(double deathPenalty)` | -| :-- | :-- | -| Lua | `void setDeathPenalty(number deathPenalty)` | -| Java | `void setDeathPenalty(double deathPenalty)` | +| C++ | `void setDeathPenalty(double deathPenalty)` | +| :-- | :-- | +| Lua | `void setDeathPenalty(number deathPenalty)` | +| Java | `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. @@ -440,10 +440,10 @@ Config key: deathPenalty / death_penalty ### `getLastReward` -| C++ | `double getLastReward()` | -| :-- | :-- | -| Lua | `number getLastReward()` | -| Java | `double getLastReward()` | +| C++ | `double getLastReward()` | +| :-- | :-- | +| Lua | `number getLastReward()` | +| Java | `double getLastReward()` | | Python | `float get_last_reward()` | Returns a reward granted after last update of state. @@ -451,10 +451,10 @@ Returns a reward granted after last update of state. ### `getTotalReward` -| C++ | `double getTotalReward()` | -| :-- | :-- | -| Lua | `number getTotalReward()` | -| Java | `double getTotalReward()` | +| C++ | `double getTotalReward()` | +| :-- | :-- | +| Lua | `number getTotalReward()` | +| Java | `double getTotalReward()` | | Python | `float get_total_reward()` | Returns the sum of all rewards gathered in the current episode. @@ -465,11 +465,11 @@ Returns the sum of all rewards gathered in the current episode. ### `loadConfig` -| C++ | `bool loadConfig(std::string filePath)` | -| :-- | :-- | -| Lua | `boolean loadConfig(string filePath)` | -| Java | `boolean loadConfig(String filePath)` | -| Python | `bool load_config(str filePath)` | +| C++ | `bool loadConfig(std::string filePath)` | +| :-- | :-- | +| Lua | `boolean loadConfig(string filePath)` | +| Java | `boolean loadConfig(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. @@ -480,10 +480,10 @@ false if file was contained errors. ### `getMode` -| C++ | `Mode getMode()` | -| :-- | :-- | -| Lua | `Mode getMode()` | -| Java | `Mode getMode()` | +| C++ | `Mode getMode()` | +| :-- | :-- | +| Lua | `Mode getMode()` | +| Java | `Mode getMode()` | | Python | `Mode get_mode()` | Returns current mode. @@ -491,10 +491,10 @@ Returns current mode. ### `setMode` -| C++ | `void setMode(Mode mode)` | -| :-- | :-- | -| Lua | `void setMode(Mode mode)` | -| Java | `void setMode(Mode mode)` | +| C++ | `void setMode(Mode mode)` | +| :-- | :-- | +| Lua | `void setMode(Mode mode)` | +| Java | `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. @@ -509,11 +509,11 @@ See also: ### `getTicrate` -| C++ | `unsigned int getTicrate()` | -| :-- | :-- | -| Lua | `number getTicrate()` | -| Java | `unsigned int getTicrate()` | -| Python | `int get_ticrate()` | +| C++ | `unsigned int getTicrate()` | +| :-- | :-- | +| Lua | `number getTicrate()` | +| Java | `unsigned int getTicrate()` | +| Python | `int get_ticrate()` | Added in 1.1 @@ -522,11 +522,11 @@ Returns current ticrate. ### `setTicrate` -| C++ | `void setTicrate(unsigned int ticrate)` | -| :-- | :-- | -| Lua | `void setTicrate(number ticrate)` | -| Java | `void setTicrate(unsigned int ticrate)` | -| Python | `void set_ticrate(int ticrate)` | +| C++ | `void setTicrate(unsigned int ticrate)` | +| :-- | :-- | +| Lua | `void setTicrate(number ticrate)` | +| Java | `void setTicrate(unsigned int ticrate)` | +| Python | `void set_ticrate(int ticrate)` | Added in 1.1 @@ -542,11 +542,11 @@ See also: ### `setViZDoomPath` -| C++ | `void setViZDoomPath(std::string filePath)` | -| :-- | :-- | -| Lua | `void setViZDoomPath(string filePath)` | -| Java | `void setViZDoomPath(String filePath)` | -| Python | `void set_vizdoom_path(str filePath)` | +| C++ | `void setViZDoomPath(std::string filePath)` | +| :-- | :-- | +| Lua | `void setViZDoomPath(string filePath)` | +| Java | `void setViZDoomPath(String filePath)` | +| Python | `void set_vizdoom_path(str filePath)` | Sets path to ViZDoom engine executable. @@ -557,11 +557,11 @@ Config key: ViZDoomPath / vizdoom_path ### `setDoomGamePath` -| C++ | `void setDoomGamePath(std::string filePath)` | -| :-- | :-- | -| Lua | `void setDoomGamePath(string filePath)` | -| Java | `void setDoomGamePath(String filePath)` | -| Python | `void set_doom_game_path(str filePath)` | +| C++ | `void setDoomGamePath(std::string filePath)` | +| :-- | :-- | +| Lua | `void setDoomGamePath(string filePath)` | +| Java | `void setDoomGamePath(String filePath)` | +| Python | `void set_doom_game_path(str filePath)` | Sets path to the Doom engine based game file (wad format). @@ -572,11 +572,11 @@ Config key: DoomGamePath / doom_game_path ### `setDoomScenarioPath` -| C++ | `void setDoomScenarioPath(std::string filePath)` | -| :-- | :-- | -| Lua | `void setDoomScenarioPath(string filePath)` | -| Java | `void setDoomScenarioPath(String filePath)` | -| Python | `void set_doom_scenario_path(str filePath)` | +| C++ | `void setDoomScenarioPath(std::string filePath)` | +| :-- | :-- | +| Lua | `void setDoomScenarioPath(string filePath)` | +| Java | `void setDoomScenarioPath(String filePath)` | +| Python | `void set_doom_scenario_path(str filePath)` | Sets path to additional scenario file (wad format). @@ -587,11 +587,11 @@ Config key: DoomScenarioPath / set_doom_scenario_path ### `setDoomMap` -| C++ | `void setDoomMap(std::string map)` | -| :-- | :-- | -| Lua | `void setDoomMap(string map)` | -| Java | `void setDoomMap(String map)` | -| Python | `void set_doom_map(str map)` | +| C++ | `void setDoomMap(std::string map)` | +| :-- | :-- | +| Lua | `void setDoomMap(string map)` | +| Java | `void setDoomMap(String map)` | +| Python | `void set_doom_map(str map)` | Sets the map name to be used. @@ -602,11 +602,11 @@ Config key: DoomMap / doom_map ### `setDoomSkill` -| C++ | `void setDoomSkill(int skill)` | -| :-- | :-- | -| Lua | `void setDoomSkill(number skill)` | -| Java | `void setDoomSkill(int skill)` | -| Python | `void setDoomSkill(int skill)` | +| C++ | `void setDoomSkill(int skill)` | +| :-- | :-- | +| Lua | `void setDoomSkill(number skill)` | +| Java | `void setDoomSkill(int skill)` | +| Python | `void setDoomSkill(int skill)` | Sets Doom game difficulty level which is called skill in Doom. The higher is the skill the harder the game becomes. @@ -626,11 +626,11 @@ Config key: skill ### `setDoomConfigPath` -| C++ | `void setDoomConfigPath(std::string filePath)` | -| :-- | :-- | -| Lua | `void setDoomConfigPath(string filePath)` | -| Java | `void setDoomConfigPath(String filePath)` | -| Python | `void set_doom_config_path(str filePath)` | +| C++ | `void setDoomConfigPath(std::string filePath)` | +| :-- | :-- | +| Lua | `void setDoomConfigPath(string filePath)` | +| Java | `void setDoomConfigPath(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. @@ -644,22 +644,22 @@ Config key: DoomConfigPath / doom_config_path ### `getSeed` -| C++ | `unsigned int getSeed()` | -| :-- | :-- | -| Lua | `number getSeed()` | -| Java | `unsigned int getSeed()` | -| Python | `int getSeed()` | +| C++ | `unsigned int getSeed()` | +| :-- | :-- | +| Lua | `number getSeed()` | +| Java | `unsigned int getSeed()` | +| Python | `int getSeed()` | Return ViZDoom's seed. ### `setSeed` -| C++ | `void setSeed(unsigned int seed)` | -| :-- | :-- | -| Lua | `void setSeed(number seed)` | -| Java | `void setSeed(unsigned int seed)` | -| Python | `void set_seed(int seed)` | +| C++ | `void setSeed(unsigned int seed)` | +| :-- | :-- | +| Lua | `void setSeed(number seed)` | +| Java | `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. @@ -673,22 +673,22 @@ See also: ### `getEpisodeStartTime` -| C++ | `unsigned int getEpisodeStartTime()` | -| :-- | :-- | -| Lua | `number getEpisodeStartTime()` | -| Java | `unsigned int getEpisodeStartTime()` | -| Python | `int get_episode_start_time()` | +| C++ | `unsigned int getEpisodeStartTime()` | +| :-- | :-- | +| Lua | `number getEpisodeStartTime()` | +| Java | `unsigned int getEpisodeStartTime()` | +| Python | `int get_episode_start_time()` | Returns start delay of every episode in tics. ### `setEpisodeStartTime` -| C++ | `void setEpisodeStartTime(unsigned int tics)` | -| :-- | :-- | -| Lua | `void setEpisodeStartTime(number tics)` | -| Java | `setEpisodeStartTime(unsigned int tics)` | -| Python | `void set_episode_start_time(int tics)` | +| C++ | `void setEpisodeStartTime(unsigned int tics)` | +| :-- | :-- | +| Lua | `void setEpisodeStartTime(number tics)` | +| Java | `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. @@ -700,22 +700,22 @@ Config key: episodeStartTime / episode_start_time ### `getEpisodeTimeout` -| C++ | `unsigned int getEpisodeTimeout()` | -| :-- | :-- | -| Lua | `number getEpisodeTimeout()` | -| Java | `unsigned int getEpisodeTimeout()` | -| Python | `int get_episode_timeout()` | +| C++ | `unsigned int getEpisodeTimeout()` | +| :-- | :-- | +| Lua | `number getEpisodeTimeout()` | +| Java | `unsigned int getEpisodeTimeout()` | +| Python | `int get_episode_timeout()` | Returns the number of tics after which the episode will be finished. ### `setEpisodeTimeout` -| C++ | `void setEpisodeTimeout(unsigned int tics)` | -| :-- | :-- | -| Lua | `void setEpisodeTimeout(number tics)` | -| Java | `void setEpisodeTimeout(unsigned int tics)` | -| Python | `void set_episode_timeout(int tics)` | +| C++ | `void setEpisodeTimeout(unsigned int tics)` | +| :-- | :-- | +| Lua | `void setEpisodeTimeout(number tics)` | +| Java | `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. @@ -727,10 +727,10 @@ Config key: episodeTimeout / episode_timeout ### `setScreenResolution` -| C++ | `void setScreenResolution(ScreenResolution resolution)` | -| :-- | :-- | -| Lua | `void setScreenResolution(ScreenResolution resolution)` | -| Java | `void setScreenResolution(ScreenResolution resolution)` | +| C++ | `void setScreenResolution(ScreenResolution resolution)` | +| :-- | :-- | +| Lua | `void setScreenResolution(ScreenResolution resolution)` | +| Java | `void setScreenResolution(ScreenResolution resolution)` | | Python | `void set_screen_resolution(ScreenResolution resolution)` | Sets the screen resolution. @@ -747,10 +747,10 @@ See also: ### `getScreenFormat` -| C++ | `ScreenFormat getScreenFormat()` | -| :-- | :-- | -| Lua | `ScreenFormat getScreenFormat()` | -| Java | `ScreenFormat getScreenFormat()` | +| C++ | `ScreenFormat getScreenFormat()` | +| :-- | :-- | +| Lua | `ScreenFormat getScreenFormat()` | +| Java | `ScreenFormat getScreenFormat()` | | Python | `ScreenFormat get_screen_format()` | Returns the format of the screen buffer and the automap buffer. @@ -758,10 +758,10 @@ Returns the format of the screen buffer and the automap buffer. ### `setScreenFormat` -| C++ | `void setScreenFormat(ScreenFormat format)` | -| :-- | :-- | -| Lua | `void setScreenFormat(ScreenFormat format)` | -| Java | `void setScreenFormat(ScreenFormat format)` | +| C++ | `void setScreenFormat(ScreenFormat format)` | +| :-- | :-- | +| Lua | `void setScreenFormat(ScreenFormat format)` | +| Java | `void setScreenFormat(ScreenFormat format)` | | Python | `void set_screen_format(ScreenFormat format)` | Sets the format of the screen buffer and the automap buffer. @@ -778,11 +778,11 @@ See also: ### `isDepthBufferEnabled` -| C++ | `bool isDepthBufferEnabled()` | -| :-- | :-- | -| Lua | `boolean isDepthBufferEnabled()` | -| Java | `boolean isDepthBufferEnabled()` | -| Python | `bool isDepthBufferEnabled()` | +| C++ | `bool isDepthBufferEnabled()` | +| :-- | :-- | +| Lua | `boolean isDepthBufferEnabled()` | +| Java | `boolean isDepthBufferEnabled()` | +| Python | `bool isDepthBufferEnabled()` | Added in 1.1 @@ -791,10 +791,10 @@ Returns true if the depth buffer is enabled. ### `setDepthBufferEnabled` -| C++ | `void setDepthBufferEnabled(bool depthBuffer)` | -| :-- | :-- | -| Lua | `void setDepthBufferEnabled(boolean depthBuffer)` | -| Java | `void setDepthBufferEnabled(boolean depthBuffer)` | +| C++ | `void setDepthBufferEnabled(bool depthBuffer)` | +| :-- | :-- | +| Lua | `void setDepthBufferEnabled(boolean depthBuffer)` | +| Java | `void setDepthBufferEnabled(boolean depthBuffer)` | | Python | `void set_depth_buffer_enabled(bool depthBuffer)` | Added in 1.1 @@ -812,11 +812,11 @@ See also: ### `isLabelsBufferEnabled` -| C++ | `bool isLabelsBufferEnabled()` | -| :-- | :-- | -| Lua | `boolean isLabelsBufferEnabled()` | -| Java | `boolean isLabelsBufferEnabled()` | -| Python | `bool isLabelsBufferEnabled()` | +| C++ | `bool isLabelsBufferEnabled()` | +| :-- | :-- | +| Lua | `boolean isLabelsBufferEnabled()` | +| Java | `boolean isLabelsBufferEnabled()` | +| Python | `bool isLabelsBufferEnabled()` | Added in 1.1 @@ -825,10 +825,10 @@ Returns true if the labels buffer is enabled. ### `setLabelsBufferEnabled` -| C++ | `void setLabelsBufferEnabled(bool labelsBuffer)` | -| :-- | :-- | -| Lua | `void setLabelsBufferEnabled(boolean labelsBuffer)` | -| Java | `void setLabelsBufferEnabled(boolean labelsBuffer)` | +| C++ | `void setLabelsBufferEnabled(bool labelsBuffer)` | +| :-- | :-- | +| Lua | `void setLabelsBufferEnabled(boolean labelsBuffer)` | +| Java | `void setLabelsBufferEnabled(boolean labelsBuffer)` | | Python | `void set_labels_buffer_enabled(bool labelsBuffer)` | Added in 1.1 @@ -848,11 +848,11 @@ See also: ### `isAutomapBufferEnabled` -| C++ | `bool isAutomapBufferEnabled()` | -| :-- | :-- | -| Lua | `boolean isAutomapBufferEnabled()` | -| Java | `boolean isAutomapBufferEnabled()` | -| Python | `bool isAutomapBufferEnabled()` | +| C++ | `bool isAutomapBufferEnabled()` | +| :-- | :-- | +| Lua | `boolean isAutomapBufferEnabled()` | +| Java | `boolean isAutomapBufferEnabled()` | +| Python | `bool isAutomapBufferEnabled()` | Added in 1.1 @@ -861,10 +861,10 @@ Returns true if the automap buffer is enabled. ### `setAutomapBufferEnabled` -| C++ | `void setAutomapBufferEnabled(bool automapBuffer)` | -| :-- | :-- | -| Lua | `void setAutomapBufferEnabled(boolean automapBuffer)` | -| Java | `void setAutomapBufferEnabled(boolean automapBuffer)` | +| C++ | `void setAutomapBufferEnabled(bool automapBuffer)` | +| :-- | :-- | +| Lua | `void setAutomapBufferEnabled(boolean automapBuffer)` | +| Java | `void setAutomapBufferEnabled(boolean automapBuffer)` | | Python | `void set_automap_buffer_enabled(bool automapBuffer)` | Added in 1.1 @@ -882,10 +882,10 @@ See also: ### `setAutomapMode` -| C++ | `void setAutomapMode(AutomapMode mode)` | -| :-- | :-- | -| Lua | `void setAutomapMode(AutomapMode mode)` | -| Java | `void setAutomapMode(AutomapMode mode)` | +| C++ | `void setAutomapMode(AutomapMode mode)` | +| :-- | :-- | +| Lua | `void setAutomapMode(AutomapMode mode)` | +| Java | `void setAutomapMode(AutomapMode mode)` | | Python | `void set_automap_mode(AutomapMode mode)` | Added in 1.1 @@ -901,11 +901,11 @@ See also: ### `setAutomapRotate` -| C++ | `void setAutomapRotate(bool rotate)` | -| :-- | :-- | -| Lua | `void setAutomapRotate(boolean rotate)` | -| Java | `void setAutomapRotate(boolean rotate)` | -| Python | `void set_automap_rotate(bool rotate)` | +| C++ | `void setAutomapRotate(bool rotate)` | +| :-- | :-- | +| Lua | `void setAutomapRotate(boolean rotate)` | +| Java | `void setAutomapRotate(boolean rotate)` | +| Python | `void set_automap_rotate(bool rotate)` | Added in 1.1 @@ -918,10 +918,10 @@ Config key: automapRotate / render_hud ### `setAutomapRenderTextures` -| C++ | `setAutomapRenderTextures(bool textures)` | -| :-- | :-- | -| Lua | `setAutomapRenderTextures(boolean textures)` | -| Java | `setAutomapRenderTextures(boolean textures)` | +| C++ | `setAutomapRenderTextures(bool textures)` | +| :-- | :-- | +| Lua | `setAutomapRenderTextures(boolean textures)` | +| Java | `setAutomapRenderTextures(boolean textures)` | | Python | `set_automap_render_textures(bool textures)` | Added in 1.1 @@ -935,11 +935,11 @@ Config key: automapRenderTextures / automap_render_textures ### `setRenderHud` -| C++ | `void setRenderHud(bool hud)` | -| :-- | :-- | -| Lua | `void setRenderHud(boolean hud)` | -| Java | `void setRenderHud(boolean hud)` | -| Python | `void set_render_hud(bool hud)` | +| C++ | `void setRenderHud(bool hud)` | +| :-- | :-- | +| Lua | `void setRenderHud(boolean hud)` | +| Java | `void setRenderHud(boolean hud)` | +| Python | `void set_render_hud(bool hud)` | Determine if hud will be rendered in game. @@ -950,10 +950,10 @@ Config key: renderHud / render_hud ### `setRenderMinimalHud` -| C++ | `void setRenderMinimalHud(bool minHud)` | -| :-- | :-- | -| Lua | `void setRenderMinimalHud(boolean minHud)` | -| Java | `void setRenderMinimalHud(boolean minHud)` | +| C++ | `void setRenderMinimalHud(bool minHud)` | +| :-- | :-- | +| Lua | `void setRenderMinimalHud(boolean minHud)` | +| Java | `void setRenderMinimalHud(boolean minHud)` | | Python | `void set_render_minimal_hud(bool minHud)` | Added in 1.1 @@ -967,11 +967,11 @@ Config key: renderMinimalHud / render_minimal_hud ### `setRenderWeapon` -| C++ | `void setRenderWeapon(bool weapon)` | -| :-- | :-- | -| Lua | `void setRenderWeapon(boolean weapon)` | -| Java | `void setRenderWeapon(boolean weapon)` | -| Python | `void set_render_weapon(bool weapon)` | +| C++ | `void setRenderWeapon(bool weapon)` | +| :-- | :-- | +| Lua | `void setRenderWeapon(boolean weapon)` | +| Java | `void setRenderWeapon(boolean weapon)` | +| Python | `void set_render_weapon(bool weapon)` | Determine if weapon held by player will be rendered in game. @@ -982,11 +982,11 @@ Config key: renderWeapon / render_weapon ### `setRenderCrosshair` -| C++ | `void setRenderCrosshair(bool crosshair)` | -| :-- | :-- | -| Lua | `void setRenderCrosshair(boolean crosshair)` | -| Java | `void setRenderCrosshair(boolean crosshair)` | -| Python | `void set_render_crosshair(bool crosshair)` | +| C++ | `void setRenderCrosshair(bool crosshair)` | +| :-- | :-- | +| Lua | `void setRenderCrosshair(boolean crosshair)` | +| Java | `void setRenderCrosshair(boolean crosshair)` | +| Python | `void set_render_crosshair(bool crosshair)` | Determine if crosshair will be rendered in game. @@ -997,11 +997,11 @@ Config key: renderCrosshair / render_crosshair ### `setRenderDecals` -| C++ | `void setRenderDecals(bool decals)` | -| :-- | :-- | -| Lua | `void setRenderDecals(boolean decals)` | -| Java | `void setRenderDecals(boolean decals)` | -| Python | `void set_render_decals(bool decals)` | +| C++ | `void setRenderDecals(bool decals)` | +| :-- | :-- | +| Lua | `void setRenderDecals(boolean decals)` | +| Java | `void setRenderDecals(boolean decals)` | +| Python | `void set_render_decals(bool decals)` | Determine if decals (marks on the walls) will be rendered in game. @@ -1012,11 +1012,11 @@ Config key: renderDecals / render_decals ### `setRenderParticles` -| C++ | `void setRenderParticles(bool particles)` | -| :-- | :-- | -| Lua | `void setRenderParticles(boolean particles)` | -| Java | `void setRenderParticles(boolean particles)` | -| Python | `void set_render_particles(bool particles)` | +| C++ | `void setRenderParticles(bool particles)` | +| :-- | :-- | +| Lua | `void setRenderParticles(boolean particles)` | +| Java | `void setRenderParticles(boolean particles)` | +| Python | `void set_render_particles(bool particles)` | Determine if particles will be rendered in game. @@ -1027,10 +1027,10 @@ Config key: renderParticles / render_particles ### `setRenderEffectsSprites` -| C++ | `void setRenderEffectsSprites(bool sprites)` | -| :-- | :-- | -| Lua | `void setRenderEffectsSprites(boolean sprites)` | -| Java | `void setRenderEffectsSprites(boolean sprites)` | +| C++ | `void setRenderEffectsSprites(bool sprites)` | +| :-- | :-- | +| Lua | `void setRenderEffectsSprites(boolean sprites)` | +| Java | `void setRenderEffectsSprites(boolean sprites)` | | Python | `void set_render_effects_sprites(bool sprites)` | Added in 1.1 @@ -1044,11 +1044,11 @@ Config key: renderEffectsSprites / render_effects_sprites ### `setRenderMessages` -| C++ | `void setRenderMessages(bool messages)` | -| :-- | :-- | -| Lua | `void setRenderMessages(boolean messages)` | -| Java | `void setRenderMessages(boolean messages)` | -| Python | `void set_render_messages(bool messages` | +| C++ | `void setRenderMessages(bool messages)` | +| :-- | :-- | +| Lua | `void setRenderMessages(boolean messages)` | +| Java | `void setRenderMessages(boolean messages)` | +| Python | `void set_render_messages(bool messages` | Added in 1.1 @@ -1061,11 +1061,11 @@ Config key: renderMessages / render_messages ### `setWindowVisible` -| C++ | `void setWindowVisible(bool visibility)` | -| :-- | :-- | -| Lua | `void setWindowVisible(boolean visibility)` | -| Java | `void setWindowVisible(boolean visibility)` | -| Python | `void set_window_visible(bool visibility)` | +| C++ | `void setWindowVisible(bool visibility)` | +| :-- | :-- | +| Lua | `void setWindowVisible(boolean visibility)` | +| Java | `void setWindowVisible(boolean 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 system without X Server. @@ -1077,11 +1077,11 @@ Config key: windowVisible / window_visible ### `setConsoleEnabled` -| C++ | `void setConsoleEnabled(bool console)` | -| :-- | :-- | -| Lua | `void setConsoleEnabled(boolean console)` | -| Java | `void setConsoleEnabled(boolean console)` | -| Python | `void set_console_enabled(bool console)` | +| C++ | `void setConsoleEnabled(bool console)` | +| :-- | :-- | +| Lua | `void setConsoleEnabled(boolean console)` | +| Java | `void setConsoleEnabled(boolean console)` | +| Python | `void set_console_enabled(bool console)` | Determines if ViZDoom's console output will be enabled. @@ -1092,11 +1092,11 @@ Config key: consoleEnabled / console_enabled ### `setSoundEnabled` -| C++ | `void setSoundEnabled(bool sound)` | -| :-- | :-- | -| Lua | `void setSoundEnabled(boolean sound)` | -| Java | `void setSoundEnabled(boolean sound)` | -| Python | `void set_sound_enabled(bool sound)` | +| C++ | `void setSoundEnabled(bool sound)` | +| :-- | :-- | +| Lua | `void setSoundEnabled(boolean sound)` | +| Java | `void setSoundEnabled(boolean sound)` | +| Python | `void set_sound_enabled(bool sound)` | Determines if ViZDoom's sound will be played. @@ -1107,10 +1107,10 @@ Config key: soundEnabled / sound_enabled ### `getScreenWidth` -| C++ | `int getScreenWidth()` | -| :-- | :-- | -| Lua | `int getScreenWidth()` | -| Java | `int getScreenWidth()` | +| C++ | `int getScreenWidth()` | +| :-- | :-- | +| Lua | `int getScreenWidth()` | +| Java | `int getScreenWidth()` | | Python | `int get_screen_width()` | Returns game's screen width - width of all buffers. @@ -1118,10 +1118,10 @@ Returns game's screen width - width of all buffers. ### `getScreenHeight` -| C++ | `int getScreenHeight()` | -| :-- | :-- | -| Lua | `int getScreenHeight()` | -| Java | `int getScreenHeight()` | +| C++ | `int getScreenHeight()` | +| :-- | :-- | +| Lua | `int getScreenHeight()` | +| Java | `int getScreenHeight()` | | Python | `int get_screen_height()` | Returns game's screen height - height of all buffers. @@ -1129,10 +1129,10 @@ Returns game's screen height - height of all buffers. ### `getScreenChannels` -| C++ | `int getScreenChannels()` | -| :-- | :-- | -| Lua | `int getScreenChannels()` | -| Java | `int getScreenChannels()` | +| C++ | `int getScreenChannels()` | +| :-- | :-- | +| Lua | `int getScreenChannels()` | +| Java | `int getScreenChannels()` | | Python | `int get_screen_channels()` | Returns number of channels in screen buffer and map buffer (depth and labels buffer have always one channel). @@ -1140,10 +1140,10 @@ Returns number of channels in screen buffer and map buffer (depth and labels buf ### `getScreenPitch` -| C++ | `size_t getScreenPitch()` | -| :-- | :-- | -| Lua | `size_t getScreenPitch()` | -| Java | `size_t getScreenPitch()` | +| C++ | `size_t getScreenPitch()` | +| :-- | :-- | +| Lua | `size_t getScreenPitch()` | +| Java | `size_t getScreenPitch()` | | Python | `size_t get_screen_pitch()` | Returns size in bytes of one row in screen buffer and map buffer. @@ -1151,10 +1151,10 @@ Returns size in bytes of one row in screen buffer and map buffer. ### `getScreenSize` -| C++ | `size_t getScreenSize()` | -| :-- | :-- | -| Lua | `number getScreenSize()` | -| Java | `int getScreenSize()` | -| Python | `int get_screen_size()` | +| C++ | `size_t getScreenSize()` | +| :-- | :-- | +| Lua | `number getScreenSize()` | +| Java | `int getScreenSize()` | +| Python | `int get_screen_size()` | Returns size in bytes of screen buffer and map buffer.