EHANDLE

From Valve Developer Community
Revision as of 07:32, 23 August 2006 by Dolphineye (talk | contribs) (Well, it i the contrary: ¨hPlayer = pPlayer assignes the eHandle to the pPlayer pointer and vice-versa. If I am wrong, correct again.)
Jump to navigation Jump to search

Stub

This article or section is a stub. You can help by expanding it.

A common way to address a specific entity is by its entity index ( CBaseEntity::entindex() ). Each time a new entity is instantiated, the engine looks up an unused entity index and assigns it to the new entity. Once the entity object is destroyed, its entity index becomes available again and may be reused for a different entity. Therefore the entity index is not a good way to reference a specific entity over longer times. A better and safer way is to use an EHANDLE (or CBaseHandle) to keep track of entity instances. An EHANDLE encapsulate a 32-bit ID that is unique for an entity instance during the whole game and can be used on both server and client to refer to entity objects (An EHANDLE is a combination of an entity index and an increasing serial number). An EHANDLE can be transformed to CBaseEntity and vice versa just by using its overloaded operators. If an EHANDLE resolves to NULL, the entity object is not valid anymore.

// find a player, if no player is available pPlayer and hPlayer are NULL
EHANDLE hPlayer = gEntList.FindEntityByClassname( NULL, "player" );
CBasePlayer *pPlayer = hPlayer; // convert entity pointer to EHANDLE
hPlayer = pPlayer; // convert EHANDLE into entity pointer

Related content

Networking Entities