nebula-doc/entitypool_8h_source.html

#pragma once

//------------------------------------------------------------------------------

//------------------------------------------------------------------------------

#include "api.h"

#include "category.h"

#include "util/queue.h"


namespace Game

{


//------------------------------------------------------------------------------


class EntityPool

{

public:

    // default constructor

    EntityPool();


    bool Allocate(Entity& e);

    void Deallocate(Entity e);

    bool IsValid(Entity e) const;


    Util::Array<uint16_t> generations;

    Util::Queue<uint32_t> freeIds;

};


} // namespace Game

api.h
The main programming interface for the Game Subsystem.

category.h

Game::EntityPool::EntityPool
EntityPool()
Definition entitypool.cc:16

Game::EntityPool::freeIds
Util::Queue< uint32_t > freeIds
stores freed indices
Definition entitypool.h:37

Game::EntityPool::Allocate
bool Allocate(Entity &e)
allocate a new id, returns false if the entity id was reused
Definition entitypool.cc:26

Game::EntityPool::IsValid
bool IsValid(Entity e) const
check if valid
Definition entitypool.cc:68

Game::EntityPool::generations
Util::Array< uint16_t > generations
array containing generation value for every index
Definition entitypool.h:35

Game::EntityPool::Deallocate
void Deallocate(Entity e)
remove an id
Definition entitypool.cc:52

Util::Array
Nebula's dynamic array class.
Definition array.h:61

Util::Queue
Nebula's queue class (a FIFO container).
Definition queue.h:22

Game
Game::EditorState.
Definition graphicsmanager.h:67

queue.h

Game::Entity
An entity is essentially just an Id with some utility functions attached.
Definition entity.h:35