IAreaManager

C++
struct IAreaManager {
};
File

IEntitySystem.h

IAreaManager::~IAreaManager Destructor
C++
virtual ~IAreaManager();
IAreaManager::AddEventListener Method

Registers EventListener to the AreaManager.

C++
virtual void AddEventListener(IAreaManagerEventListener * pListener) = 0;
IAreaManager::DrawLinkedAreas Method
C++
virtual void DrawLinkedAreas(EntityId linkedId) const = 0;
IAreaManager::ExitAllAreas Method
C++
virtual void ExitAllAreas(IEntity const* const pEntity) = 0;
Description

Passed in entity exits all areas. Meant for when players are killed.

IAreaManager::GetArea Method
C++
virtual IArea const* const GetArea(size_t const nAreaIndex) const = 0;
IAreaManager::GetAreaAmount Method
C++
virtual size_t GetAreaAmount() const = 0;
IAreaManager::GetLinkedAreas Method
C++
virtual bool GetLinkedAreas(EntityId linkedId, EntityId* pOutArray, int & outAndMaxResults) const = 0;
Returns

Returns true if the array was large enough, or false if there was more then outAndMaxResults attached to the entity

Description

Query areas linked to other entities (these links are shape links) fills out a list of entities and sets outAndMaxResults to the size of results

IAreaManager::GetOverlappingAreas Method
C++
virtual size_t GetOverlappingAreas(const AABB& bb, PodArray<IArea*>& list) const = 0;
IAreaManager::MarkEntityForUpdate Method
C++
virtual void MarkEntityForUpdate(EntityId const nEntityID) = 0;
Description

Puts the passed entity ID into the update list for the next update.

IAreaManager::QueryAreas Method
C++
virtual bool QueryAreas(EntityId const nEntityID, Vec3 const& vPos, SAreaManagerResult * pResults, int nMaxResults, int& rNumResults) = 0;
Returns

True on success or false on error or if provided structure was too small.

Description

Additional Query based on position. Needs preallocated space to write nMaxResults to pResults. Returns the actual number of results written in rNumResults.

IAreaManager::QueryAudioAreas Method
C++
virtual bool QueryAudioAreas(Vec3 const& rPos, SAudioAreaInfo * pResults, int nMaxResults, int& rNumResults) = 0;
Returns

True on success or false on error or if provided structure was too small.

Description

Additional Query based on position. Returns only the areas that have AudioProxies and valid AudioEnvironmentIDs. Needs preallocated space to write nMaxResults to pResults. The actual number of results filled is returned in rNumResults.

IAreaManager::RemoveEventListener Method
C++
virtual void RemoveEventListener(IAreaManagerEventListener * pListener) = 0;
IAreaManager::SetAreaDirty Method
C++
virtual void SetAreaDirty(IArea* pArea) = 0;
Description

Invokes a partial recomp of the grid (faster)

IAreaManager::SetAreasDirty Method
C++
virtual void SetAreasDirty() = 0;
Description

Invokes a re-compilation of the entire area grid