TurtleBrains  0.3.5
High quality, portable, C++ framework for rapid 2D game development.
TurtleBrains::Game::Unstable::EntityFactoryInterface Class Referenceabstract

#include <tb_entity_factory_interface.hpp>

Inheritance diagram for TurtleBrains::Game::Unstable::EntityFactoryInterface:
TurtleBrains::Core::Noncopyable

Public Member Functions

 EntityFactoryInterface (EntityManager &entityManager)
 
virtual ~EntityFactoryInterface (void)
 
Entity * AddEntity (const String &entityTypeName, const tbCore::DynamicStructure &entityProperties)
 

Protected Member Functions

virtual Entity * CreateEntityByType (const String &entityTypeName, const tbCore::DynamicStructure &entityProperties)=0
 
virtual bool DestroyEntity (Entity *entityToDestroy)=0
 

Detailed Description

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

Note
this is not yet useful.

Constructor & Destructor Documentation

◆ EntityFactoryInterface()

TurtleBrains::Game::Unstable::EntityFactoryInterface::EntityFactoryInterface ( EntityManager &  entityManager)
explicit

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

◆ ~EntityFactoryInterface()

virtual TurtleBrains::Game::Unstable::EntityFactoryInterface::~EntityFactoryInterface ( void  )
virtual

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

Member Function Documentation

◆ CreateEntityByType()

virtual Entity* TurtleBrains::Game::Unstable::EntityFactoryInterface::CreateEntityByType ( const String &  entityTypeName,
const tbCore::DynamicStructure &  entityProperties 
)
protectedpure virtual

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

Note
Currently this MUST allocate on the heap, by using new. NOT new [], NOT malloc, NOT any other means because at present time the DestroyEntity() function is NOT called upon deletion, and delete entity; is used for cleanup.

◆ DestroyEntity()

virtual bool TurtleBrains::Game::Unstable::EntityFactoryInterface::DestroyEntity ( Entity *  entityToDestroy)
protectedpure virtual

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