IPS_SetIdent

Require: IP-Symcon >= 2.5

 boolean IPS_SetIdent (int $ObjectID, string $Ident) 

Parameters

Returns

If the command succeeds, it returns TRUE, otherwise FALSE.

Description

This function assigns the identifier Ident to the object with ID ObjectID. The identifier is a string that may consist of letters and numbers and is invisible to the end user. It can be used to find objects within a level without using the unique and system dependent ID. For example, all state variables of an instance can be adressed by identifiers and can be handled equivalently for copies of that instance. The function can be used on all the objects that have an ID for identification.

Within a single level, an identifier is unique. Thus, the function IPS_GetObjectIDByIdent returns the intended object.

Example

IPS_SetIdent(47381, "TEMPERATURE");