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

A variable is an asset that represents a feature of the story world state that can change. More...

#include <tt/world/Variable.h>

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 Signature * getSignature () const
 Returns the signature of this object.

Public Attributes

int id
 This asset's ID number, which is unique among other assets of the same type.
std::string name
 This asset's name, which is unique among other assets of the same type.
std::string encoding
 The name of the encoding this variable uses to encode its values.

Friends

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

Detailed Description

A variable is an asset that represents a feature of the story world state that can change.

A state assign a value to each of a story world's variables.

Author
Gage Birchmeier

Member Function Documentation

◆ getDescription()

const std::string & tt::Variable::getDescription ( ) const

Returns a human-readable natural language description of the object.

Returns
a human-readable natural language description of the object

◆ getSignature()

const Signature * tt::Variable::getSignature ( ) const

Returns the signature of this object.

Returns
a pointer to the signature of this Variable.

◆ toString()

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

Returns a string representation of this object.

Returns
a string describing this object

◆ operator<<

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

Override stream insertion operator to allow printing the Variable class.

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

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