TurtleBrains::Game Namespace Reference

This is the heart of TurtleBrains for game developers to create GameScenes and Entities to interact with. More...

Classes
struct	AboutTile
class	Entity
class	EntityBehaviorInterface
class	EntityManager
class	GameApplication
class	GameScene
class	GameTimer
class	InputAction
class	TileSystem

Typedefs
typedef tbCore::tbString	EntityType
typedef std::list< EntityType >	EntityTypeContainer
typedef tbCore::uint16	TileIndex
typedef tbCore::uint16	TileLocation
typedef tbCore::uint8	TileSetIndex
	TODO: TurtleBrains: Documentation: Teach the user how to use this.
typedef std::vector< AboutTile >	AboutTileContainer
	TODO: TurtleBrains: Documentation: Teach the user how to use this.

Functions
bool	operator== (const TurtleBrains::Game::GameTimer &left, const TurtleBrains::Game::GameTimer &right)
bool	operator!= (const TurtleBrains::Game::GameTimer &left, const TurtleBrains::Game::GameTimer &right)
bool	operator>= (const TurtleBrains::Game::GameTimer &left, const TurtleBrains::Game::GameTimer &right)
bool	operator<= (const TurtleBrains::Game::GameTimer &left, const TurtleBrains::Game::GameTimer &right)
bool	operator> (const TurtleBrains::Game::GameTimer &left, const TurtleBrains::Game::GameTimer &right)
bool	operator< (const TurtleBrains::Game::GameTimer &left, const TurtleBrains::Game::GameTimer &right)

Variables
const TileIndex	kInvalidTileIndex
const TileLocation	kInvalidTileLocation
	TODO: TurtleBrains: Documentation: Teach the user how to use this.
const TileSetIndex	kInvalidTileSetIndex
	TODO: TurtleBrains: Documentation: Teach the user how to use this.

Detailed Description

TODO: TIM: Documentation: This is still early in development and the Game framework is still being designed.

Requirements:

TCL_SUBST TurtleBrains::Graphics

TCL_SUBST TurtleBrains::Core

TCL_SUBST TurtleBrains::Audio

Typedef Documentation

typedef tbCore::tbString TurtleBrains::Game::EntityType

Each entity contains one or more entity types that are used to identify it during collisions or other interactions with the other entities.

typedef std::list<EntityType> TurtleBrains::Game::EntityTypeContainer

A container that holds multiple entity types that can be iterated over or checked on.

typedef tbCore::uint16 TurtleBrains::Game::TileIndex

The TileIndex is a 16bit unsigned integer value indexing into a TileSet for a specific tile. This means each TileSet is limited to a maximum of 65535 different tiles, kinda like 256 columns by 256 rows, or 512 columns by 128 rows or any other combination. Seriously though, that is a lot of tiles on a single tileset. The maximum value is reserved for kInvalidTileIndex.

typedef tbCore::uint16 TurtleBrains::Game::TileLocation

TODO: TurtleBrains: Documentation: Teach the user how to use this.

Variable Documentation

const TileIndex TurtleBrains::Game::kInvalidTileIndex

A TileIndex value that represents no tile, an empty / invalid TileIndex.