diff --git a/docs/api/cpp/game_state.md b/docs/api/cpp/game_state.md index df0b5a84c..a698a2558 100644 --- a/docs/api/cpp/game_state.md +++ b/docs/api/cpp/game_state.md @@ -72,7 +72,8 @@ Description of the object in the labels buffer. **objectName / object_name** - ingame object name, many different objects can have the same name (e.g. Medikit, Clip, Zombie). -**objectCategory / object_category** - category of the object (e.g. "Monster", "Weapon", "Player"). Category "Self" is assigned to current player. +**objectCategory / object_category** - category of the object (e.g. "Monster", "Weapon", "Player"). Category "Self" is assigned to current player. +The category assigment may not be accurate, especcialy for custom objects and WADs other than Freedoom/Doom. Note: added in 1.3.0. **value** - value that represents this particular object in **labelsBuffer**. @@ -89,7 +90,9 @@ See also: (`C++ type / Python type` **name**) - `unsigned int / int` **id** +- `int / int` **sectorId / sector_id** - `std::string / str` **name** +- `std::string / str` **category** - `double / float` **positionX / position_x** - `double / float` **positionY / position_y** - `double / float` **positionZ / position_z** @@ -102,12 +105,17 @@ See also: Description of the object present in the game world. -**id** - unique object ID. +**id** - unique object ID. This is the value referenced by **Label.objectId / object_id**. **name** - ingame object name, many different objects can have the same name (e.g. Medikit, Clip, Zombie). +**category** - category of the object (e.g. "Monster", "Weapon", "Player"). Category "Self" is assigned to current player. +The category assigment may not be accurate, especcialy for custom objects and WADs other than Freedoom/Doom. Note: added in 1.3.1. + +**sectorId / sector_id** - ID of the sector the object currently belongs to (same as corresponding **Sector.id**). Note: added in 1.3.1. + See also: -- [`DoomGame::setObjectsInfoEnabled`](./doom_game.md#setsectorsinfoenabled), +- [`DoomGame::setObjectsInfoEnabled`](./doom_game.md#setobjectsinfoenabled), - [examples/python/objects_and_sectors.py](https://github.com/Farama-Foundation/ViZDoom/tree/master/examples/python/objects_and_sectors.py). Note: added in 1.1.8. @@ -141,12 +149,15 @@ Note: added in 1.1.8. ### `Sector` (`C++ type / Python type` **name**) -- `double / float` **floorHeight / floor_height** +- `unsigned int / int` **id** +- `double / float` **floorHeight / floor_height** - Note: before 1.3.1 the value of floorHeight was inverted (negative). The bug was fixed in 1.3.1. - `double / float` **ceilingHeight / ceiling_height** -- `std::vector