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

A signature is a logical object that identifies a parameterized asset in a story world. More...

#include <tt/world/Signature.h>

Public Member Functions

const std::vector< const Value * > & getArguments () const
 Returns an unmodifiable list of all arguments defined in this story world ordered by the ID numbers.
std::string toString () const
 Returns a string representation of this object.

Public Attributes

std::string name
 The signature's name.

Friends

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

Detailed Description

A signature is a logical object that identifies a parameterized asset in a story world.

A signature is defined by a name and an ordered sequence of 0 to many values, called its arguments. Signatures make it possible to tell how different assets of the same type are similar and different from one another.

Author
Gage Birchmeier

Member Function Documentation

◆ getArguments()

const std::vector< const Value * > & tt::Signature::getArguments ( ) const

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

Returns
a vector of arguments defined in this story world

◆ toString()

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

Returns a string representation of this object.

Returns
a string describing this object

◆ operator<<

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

Override stream insertion operator to allow printing the Signature class.

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

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