diff --git a/docs/api/cpp/doomGame.md b/docs/api/cpp/doomGame.md index 2a2993c14..86ae7c929 100644 --- a/docs/api/cpp/doomGame.md +++ b/docs/api/cpp/doomGame.md @@ -57,10 +57,10 @@ Then the rest of the players must also call this method to start a new episode. Added in 1.1.0 -Replays a recorded episode from the given file using the perspective of the specified player. -Players are numbered from 1, `player` equal to 0 results in replaying the demo using the perspective of the default player in the recording file. +Replays the recorded episode from the given file using the perspective of the specified player. +Players are numbered from 1, If `player` is equal to 0, the episode will be replayed using the perspective of the default player in the recording file. After calling this method, the first state from the replay will be available. -All rewards, variables, and states are available during the replaying episode. +All rewards, variables, and states are available when replaying the episode. See also: - [examples/python/record_episodes.py](https://github.com/Farama-Foundation/ViZDoom/tree/master/examples/python/record_episodes.py) @@ -74,7 +74,7 @@ See also: | :-- | :-- | | Python | `is_running() -> bool` | -Checks if the ViZDoom game instance is running. +Checks if the controlled game instance is running. --- @@ -110,7 +110,7 @@ Checks if the game is in recording mode. Added in 1.1.5 -Checks if the game is in replaying mode. +Checks if the game is in replay mode. --- @@ -121,7 +121,8 @@ Checks if the game is in replaying mode. | Python | `set_action(actions: list | tuple | ndarray [float]) -> None` | Sets the player's action for the next tics. -Each value corresponds to a button specified with [`addAvailableButton`](#addavailablebutton) method +Each value corresponds to a button previously specified +with [`addAvailableButton`](#addavailablebutton), or [`setAvailableButtons`](#setavailablebuttons) methods, or in the configuration file (in order of appearance). @@ -132,7 +133,7 @@ or in the configuration file (in order of appearance). | :-- | :-- | | Python | `advance_action(tics: int = 1, updateState: bool = True) -> None` | -Processes a specified number of tics. If `updateState` is set, +Processes the specified number of tics. If `updateState` is set, the state will be updated after the last processed tic and a new reward will be calculated. To get the new state, use `getState` and to get the new reward use `getLastReward`. If `updateState` is not set, the state will not be updated. @@ -145,8 +146,8 @@ If `updateState` is not set, the state will not be updated. | :-- | :-- | | Python | `make_action(actions: list | tuple | ndarray [float], tics: int = 1) -> float` | -Method combining usability of [`setAction`](#setaction), [`advanceAction`](#advanceaction) and [`getLastReward`](#getlastreward). -Sets the player's action for the next tics, processes a specified number of tics, +This method combines functionality of [`setAction`](#setaction), [`advanceAction`](#advanceaction) and [`getLastReward`](#getlastreward). +Sets the player's action for the next tics, processes the specified number of tics, updates the state and calculates a new reward, which is returned. @@ -314,10 +315,12 @@ See also: | C++ | `void setAvailableButtons(std::vector