handle ( void* object);

Returns a handle of an engine object. A handle is a unique number that can be assigned to any var or skill , and identifies that object.

Parameters:

object - ENTITY*, STRING*, BMAP*, VIEW*, PANEL*, TEXT*, FONT*, SOUND*, or MATERIAL* pointer.

Returns:

Handle of object.

Speed:

Fast

Remarks:

No object (invalid) -1
HBYTE_STRING 2
HBYTE_ENTITY 4
HBYTE_ENTITY_LOCAL 5
HBYTE_ENTITY_LAYER 8
HBYTE_FONT 11
HBYTE_BMAP 12
HBYTE_MATERIAL 13
HBYTE_SOUND 14
HBYTE_STREAM 15
HBYTE_TEXT 20
HBYTE_PANEL 21
HBYTE_VIEW 22
HBYTE_PARTICLE 23

Example:

if(entity)
{
  my.skill48 = handle(entity); // store entity pointer
}
you = ptr_for_handle(my.skill48); // restore YOU;

See also:

ptr_for_handle, pVars

► latest version online