GameState

class GameState

Contains the state of the game including screen buffer, game variables, and world geometry, available information depand on the configuration of the game instance.

property audio_buffer

property automap_buffer

property depth_buffer

property game_variables

property labels

property labels_buffer

property number

property objects

property screen_buffer

property sectors

property tic

number - number of the state in the episode.

tic - ingame time, 1 tic is 1/35 of second in the game world. Note: added in 1.1.1.

See also:

• DoomGame.get_state,

• examples/python/basic.py,

• examples/python/buffers.py.

• examples/python/audio_buffer.py.

Data types used in GameState

class Label

Represents object labels in the game world with associated properties.

property height

property object_angle

property object_id

property object_name

property object_pitch

property object_position_x

property object_position_y

property object_position_z

property object_roll

property object_velocity_x

property object_velocity_y

property object_velocity_z

property value

property width

property x

property y

object_id - unique object ID, if both Labels and Objects information is enabled, this will be the same as id in corresponding Object.

object_name - ingame object name, many different objects can have the same name (e.g. Medikit, Clip, Zombie).

value - value that represents this particular object in labels_buffer.

x, y, width, height - describes bounding box of this particular object in labels_buffer. Note: added in 1.1.5.

See also:

• DoomGame.set_labels_buffer_enabled,

• examples/python/objects_and_sectors.py.

class Object

Represents objects in the game world with position and other properties.

property angle

property id

property name

property pitch

property position_x

property position_y

property position_z

property roll

property velocity_x

property velocity_y

property velocity_z

id - unique object ID.

name - ingame object name, many different objects can have the same name (e.g. Medikit, Clip, Zombie).

See also:

• DoomGame.set_objects_info_enabled,

• examples/python/objects_and_sectors.py.

Note: added in 1.1.8.

class Line

Represents line segments in the game world geometry.

property is_blocking

property x1

property x2

property y1

property y2

x1, y1 - position of the line’s first vertex.

x2, y2 - position of the line’s second vertex.

is_blocking - is true, if line is a wall that can’t be passed.

See also:

• examples/python/objects_and_sectors.py.

Note: added in 1.1.8.

class Sector

Represents sectors (floor/ceiling areas) in the game world geometry.

property ceiling_height

property floor_height

property lines

floor_height - height of the sector’s floor.

ceiling_height - height of the sector’s ceiling.

lines - contains list of line segments, that forms sector.

See also:

• DoomGame.set_sectors_info_enabled,

• examples/python/objects_and_sectors.py.

Note: added in 1.1.8.

class ServerState

Contains the state of the multiplayer server.

property player_count

property players_afk

property players_frags

property players_in_game

property players_last_action_tic

property players_last_kill_tic

property players_names

property tic

ServerState is the main object returned by DoomGame.get_server_state method, and it purpose is to get more information about the state of the multi-player game.

See also:

• DoomGame.get_server_state.

Note: added in 1.1.6.