Retrieve a ZMAP handle to a map.
ZMAP CExtAPI::map_GetMap(LPCSTR lpMapName);
| Name | Type | Comment |
|---|---|---|
| lpMapName | LPCSTR | A pointer to a C-style string containing the name of the map to be retrieved. |
False if an error occurred, and a valid non-nul ZMAP handle otherwise.
To retrieve maps from the L3DT project, use the following values of lpMapName:
| lpMapName | Which map is it? |
|---|---|
| “project.DM” | The design map. |
| “project.HF” | The heightfield. |
| “project.WM” | The water map. |
| “project.WS” | The water salinity map. |
| “project.AM” | The attributes map. |
| “project.TN” | The terrain normals map. |
| “project.LM” | The light map. |
| “project.TX” | The texture map. |
map_GetMap is equivalent to calling var_GetVar with an lpVarName of “maps.[insert lpMapName here]”, but is guaranteed to return either a ZMAP of type VarID_map, or NULL. In contrast, map_GetMap will return other variable types too.