mirror of
https://github.com/Mauler125/r5sdk.git
synced 2025-02-09 19:15:03 +01:00
Client: add documentation to IClientEntityList interface
This commit is contained in:
parent
742195eb92
commit
06b5d9a2a2
@ -5,18 +5,35 @@
|
||||
|
||||
class C_BaseEntity;
|
||||
|
||||
//-----------------------------------------------------------------------------
|
||||
// Purpose: Exposes IClientEntity's to engine
|
||||
//-----------------------------------------------------------------------------
|
||||
class IClientEntityList
|
||||
{
|
||||
public:
|
||||
virtual C_BaseEntity* GetBaseEntity(const int entNum) = 0;
|
||||
|
||||
// Get IClientNetworkable interface for specified entity
|
||||
virtual IClientNetworkable* GetClientNetworkable(const int entNum) = 0;
|
||||
virtual IClientNetworkable* GetClientNetworkableFromHandle(const CBaseHandle& handle) = 0;
|
||||
virtual IClientUnknown* GetClientUnknownFromHandle(const CBaseHandle& handle) = 0;
|
||||
|
||||
// NOTE: This function is only a convenience wrapper.
|
||||
// It returns GetClientNetworkable( entnum )->GetIClientEntity().
|
||||
virtual IClientEntity* GetClientEntity(const int entNum) = 0;
|
||||
virtual IClientEntity* GetClientEntityFromHandle(const CBaseHandle& handle) = 0;
|
||||
|
||||
// Returns number of entities currently in use
|
||||
virtual int NumberOfEntities(const bool includeNonNetworkable = false) = 0;
|
||||
|
||||
// Returns number of non networkable entities
|
||||
virtual int GetNumClientNonNetworkable() = 0;
|
||||
|
||||
// Returns highest index actually used
|
||||
virtual int GetHighestEntityIndex() = 0;
|
||||
|
||||
// Sizes entity list to specified size
|
||||
virtual void SetMaxEntities(const int maxEnts) = 0;
|
||||
virtual int GetMaxEntities() = 0;
|
||||
};
|
||||
};
|
||||
|
||||
|
Loading…
x
Reference in New Issue
Block a user