Project Malmo  0.30.0
Public Member Functions | Public Attributes | Friends | List of all members
malmo::WorldState Struct Reference

Represents the state of the game world at a moment in time. More...

#include <WorldState.h>

Public Member Functions

void clear ()
 Resets the world state to be empty, with no mission running.
 

Public Attributes

bool has_mission_begun
 Specifies whether the mission had begun when this world state was taken (whether or not it has since finished).
 
bool is_mission_running
 Specifies whether the mission was still running at the moment this world state was taken.
 
int number_of_video_frames_since_last_state
 Contains the number of video frames that have been received since the last time the world state was taken. More...
 
int number_of_rewards_since_last_state
 Contains the number of rewards that have been received since the last time the world state was taken. More...
 
int number_of_observations_since_last_state
 Contains the number of observations that have been received since the last time the world state was taken. More...
 
std::vector< boost::shared_ptr< TimestampedVideoFrame > > video_frames
 Contains the timestamped video frames that are stored in this world state. More...
 
std::vector< boost::shared_ptr< TimestampedReward > > rewards
 Contains the timestamped rewards that are stored in this world state. More...
 
std::vector< boost::shared_ptr< TimestampedString > > observations
 Contains the timestamped observations that are stored in this world state. More...
 
std::vector< boost::shared_ptr< TimestampedString > > mission_control_messages
 Contains the timestamped mission control messages that are stored in this world state.
 
std::vector< boost::shared_ptr< TimestampedString > > errors
 If there are errors in receiving the messages then we log them here.
 

Friends

std::ostream & operator<< (std::ostream &os, const WorldState &ws)
 

Detailed Description

Represents the state of the game world at a moment in time.

Member Data Documentation

int malmo::WorldState::number_of_observations_since_last_state

Contains the number of observations that have been received since the last time the world state was taken.

May differ from the number of observations that are stored, depending on the observations policy that was used.

See also
observations
int malmo::WorldState::number_of_rewards_since_last_state

Contains the number of rewards that have been received since the last time the world state was taken.

May differ from the number of rewards that are stored, depending on the rewards policy that was used.

See also
rewards
int malmo::WorldState::number_of_video_frames_since_last_state

Contains the number of video frames that have been received since the last time the world state was taken.

May differ from the number of video frames that are stored, depending on the video frames policy that was used.

See also
video_frames
std::vector< boost::shared_ptr< TimestampedString > > malmo::WorldState::observations

Contains the timestamped observations that are stored in this world state.

May differ from the number of observations that were received, depending on the observations policy that was used.

See also
AgentHost::setObservationsPolicy
std::vector< boost::shared_ptr< TimestampedReward > > malmo::WorldState::rewards

Contains the timestamped rewards that are stored in this world state.

May differ from the number of rewards that were received, depending on the rewards policy that was used.

See also
AgentHost::setRewardsPolicy
std::vector< boost::shared_ptr< TimestampedVideoFrame > > malmo::WorldState::video_frames

Contains the timestamped video frames that are stored in this world state.

May differ from the number of video frames that were received, depending on the video policy that was used.

See also
AgentHost::setVideoPolicy

The documentation for this struct was generated from the following file: