TT Client Library 1.0.0
C++ library for Tandem Tales clients.
Loading...
Searching...
No Matches
tt::World Class Reference

A story world is a collection of assets needed for two partners in a session to tell a collaborative story. More...

#include <tt/world/World.h>

Public Member Functions

std::string toString () const
 Returns a string representation of this object.
const std::vector< const Entity * > & getEntities () const
 Returns an unmodifiable list of all entities defined in this story world ordered by the ID numbers.
const std::vector< const Variable * > & getVariables () const
 Returns an unmodifiable list of all variables defined in this story world ordered by the ID numbers.
const std::vector< const Action * > & getActions () const
 Returns an unmodifiable list of all actions defined in this story world ordered by the ID numbers.
const std::vector< const Ending * > & getEndings () const
 Returns an unmodifiable list of all endings defined in this story world ordered by the ID numbers.

Public Attributes

std::string name
 The unique name of this story world.
std::string title
 The short natural language title of the world.
std::string description
 The longer natural language description of the world.

Friends

std::ostream & operator<< (std::ostream &os, const World &a)
 Override stream insertion operator to allow printing the World class.

Detailed Description

A story world is a collection of assets needed for two partners in a session to tell a collaborative story.

Author
Gage Birchmeier

Member Function Documentation

◆ getActions()

const std::vector< const Action * > & tt::World::getActions ( ) const

Returns an unmodifiable list of all actions defined in this story world ordered by the ID numbers.

Returns
a vector of actions defined in this story world

◆ getEndings()

const std::vector< const Ending * > & tt::World::getEndings ( ) const

Returns an unmodifiable list of all endings defined in this story world ordered by the ID numbers.

Returns
a vector of endings defined in this story world

◆ getEntities()

const std::vector< const Entity * > & tt::World::getEntities ( ) const

Returns an unmodifiable list of all entities defined in this story world ordered by the ID numbers.

Returns
a vector of entities defined in this story world

◆ getVariables()

const std::vector< const Variable * > & tt::World::getVariables ( ) const

Returns an unmodifiable list of all variables defined in this story world ordered by the ID numbers.

Returns
a vector of variables defined in this story world

◆ toString()

std::string tt::World::toString ( ) const

Returns a string representation of this object.

Returns
a string describing this object

◆ operator<<

std::ostream & operator<< ( std::ostream & os,
const World & a )
friend

Override stream insertion operator to allow printing the World class.

Parameters
osan output stream to insert into
aa reference to a world object
Returns
the output stream referenced

The documentation for this class was generated from the following files: