native

entity_get_string

Syntax

native entity_get_string(iIndex, iKey, szReturn[], iRetLen);

Description

Retrieves a string type value from an entities entvar struct.

Parameters

iIndex Entity index
iKey Entry to retrieve from
szReturn Buffer to copy value to
iRetLen Maximum size of buffer

Note

For a list of valid string type entries, see the EV_SZ_* constants in
engine_const.inc

Return

Number of cells written to buffer, 0 if an invalid entry
was specified

Error

If an invalid entity index is provided, an error will be
thrown.