Changes the name of a variable.
bool CExtAPI::var_Rename(ZVAR hVar, const char* lpNewName);
Name | Type | Comment |
---|---|---|
hVar | ZVAR | A ZVAR handle to the variable to be renamed. |
lpNewName | const char* | A pointer to a C-style string containing the new name of the variable. |
False if:
True otherwise.
This function allows you to rename any variable in the shared memory (e.g. those created by var_Create), including those created by other plugins. Furthermore, you can re-name important stuff like L3DT's project maps or file formats, which will only result in pain and suffering for all. Hence, plugins should only call var_Rename on variables they have created, and only then in moderation.