TurtleBrains::Game::KillBehavior Class Reference

#include <tb_entity_behavior_interface.h>

Inheritance diagram for TurtleBrains::Game::KillBehavior:

Public Member Functions
	KillBehavior (Entity &entity)
virtual	~KillBehavior (void)
virtual void	OnSimulate (void)
Public Member Functions inherited from TurtleBrains::Game::EntityBehaviorInterface
	EntityBehaviorInterface (Entity &entity)
virtual	~EntityBehaviorInterface (void)=0

Additional Inherited Members
Protected Member Functions inherited from TurtleBrains::Game::EntityBehaviorInterface
virtual void	OnAdded (void)
virtual void	OnRemoved (void)
virtual void	OnPaused (void)
virtual void	OnResume (void)
virtual void	OnUpdate (const float deltaTime)
virtual void	OnRender (void) const
virtual void	OnCollideWith (const Entity &other)
Protected Attributes inherited from TurtleBrains::Game::EntityBehaviorInterface
Entity &	mEntity

Detailed Description

The KillBehavior is a simple behavior that will remove the entity from entity manager that it exists within. Note this does not delete the entity, although the entity manager may depending on how the entity was added.

Constructor & Destructor Documentation

TurtleBrains::Game::KillBehavior::KillBehavior ( Entity &  entity )

inline

Constructs a KillBehavior for a specific entity.

Parameters

entity

The entity that will be removed from the EntityManager it belongs to on the first call to Simulate.

virtual TurtleBrains::Game::KillBehavior::~KillBehavior ( void  )

inlinevirtual

Destructs the KillBehavior.

Member Function Documentation

virtual void TurtleBrains::Game::KillBehavior::OnSimulate ( void  )

virtual

Removes the entity from the EntityManager it belongs to.

Reimplemented from TurtleBrains::Game::EntityBehaviorInterface.