|
TT Client Library 1.0.0
C++ library for Tandem Tales clients.
|
A turn is one participant in a session communicating their intentions for an action to the other participant.
More...
#include <tt/world/Turn.h>
Public Types | |
| enum | Type { PROPOSE , SUCCEED , FAIL , PASS } |
| The kind of turn being taken. More... | |
Public Member Functions | |
| std::string | toString () const |
| Returns a string representation of this object. | |
| const std::string & | getDescription () const |
| Returns a human-readable natural language description of the object. | |
| const std::string & | getCode () const |
Returns a string of 1's and 0's that uniquely represents this object among other objects of the same type in the same story world. | |
| const Action * | getAction () const |
| Returns the action associated with this turn. | |
Public Attributes | |
| Role | role |
| The role of the participant taking this turn. | |
| Type | type |
| The kind of turn being taken. | |
Friends | |
| std::ostream & | operator<< (std::ostream &os, const Turn &a) |
| Override stream insertion operator to allow printing the Turn class. | |
A turn is one participant in a session communicating their intentions for an action to the other participant.
There are four types of turns:
| enum tt::Turn::Type |
The kind of turn being taken.
| const Action * tt::Turn::getAction | ( | ) | const |
Returns the action associated with this turn.
| const std::string & tt::Turn::getCode | ( | ) | const |
Returns a string of 1's and 0's that uniquely represents this object among other objects of the same type in the same story world.
Every encoded object of the same type should return a string of the same length, even if it must be padded with 0's.
| const std::string & tt::Turn::getDescription | ( | ) | const |
Returns a human-readable natural language description of the object.
| std::string tt::Turn::toString | ( | ) | const |
Returns a string representation of this object.
|
friend |
Override stream insertion operator to allow printing the Turn class.
| os | an output stream to insert into |
| a | a reference to a turn object |