GetDesc
Category: Objects
/ Status
Since engine version: 4.6.5.0 CP
(extended in 4.9.1.0 GWE)
Description
Returns the description of an object or of an object definition. Descriptions are stored in the Desc**.txt files of an object definition group.
Syntax
string GetDesc
(object pObj, id idDef);
Parameters
- pObj:
[opt]
Object of which to get the description. Can be 0 in local calls.
- idDef:
[opt]
If specified, the description of the object definition is returned instead.
Example
Message("%s|<c ff0000>%s</c>", 0, GetName(GetCursor()), GetDesc(GetCursor()));
Displays a message containing the name of the selected clonk and the description text of the clonk type.
Sven2, Juni 2003
