CORGI
An open source project by FPL.
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Groups Pages
corgi::Entity Class Reference

The basic Entity class for CORGI. It contains an array of index values, which are used by Components for tracking their data associated with an Entity. It also contains a boolean for tracking if this Entity has been marked for deletion. More...

#include <entity.h>

Detailed Description

The basic Entity class for CORGI. It contains an array of index values, which are used by Components for tracking their data associated with an Entity. It also contains a boolean for tracking if this Entity has been marked for deletion.

Public Member Functions

 Entity ()
 Constructor for creating an Entity.
 
bool marked_for_deletion () const
 An accessor function to check if this Entity has been marked for deletion. More...
 
void set_marked_for_deletion (bool marked_for_deletion)
 A mutator function to set an Entity as marked for deletion. More...
 
EntityIdType entity_id () const
 Returns the unique entity id that represents this entity. Should generally only be used by internal CORGI functions. Users of the library should usually refer to entities as EntityRefs.
 
void set_entity_id (EntityIdType entity_id)
 Sets an entity's unique ID. More...
 

Member Function Documentation

bool corgi::Entity::marked_for_deletion ( ) const
inline

An accessor function to check if this Entity has been marked for deletion.

Returns
Returns a bool indicating whether or not this Entity is marked for deletion.
void corgi::Entity::set_entity_id ( EntityIdType  entity_id)
inline

Sets an entity's unique ID.

Normally only used internally by the entitymanager for bookkeeping.

void corgi::Entity::set_marked_for_deletion ( bool  marked_for_deletion)
inline

A mutator function to set an Entity as marked for deletion.

Parameters
[in]marked_for_deletionA bool corresponding to whether the Entity should be marked for deletion or not.

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