====== map_GetMap ======

<note warning>
This function has been deprecated. Please use [[zeolite:functions:project_GetMap]] instead.
</note>

===== Description =====

Retrieve a ZMAP handle to a map. 

===== Function prototype =====

<code>ZMAP CExtAPI::map_GetMap(LPCSTR lpMapName);</code>

===== Arguments =====

^ Name ^ Type ^ Comment ^
| lpMapName | LPCSTR | A pointer to a C-style string containing the name of the map to be retrieved. |

===== Return value =====

False if an error occurred, and a valid non-nul ZMAP handle otherwise.

===== Comments =====

==== Retrieving maps from L3DT ====

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. |

==== Difference with var_GetVar ====

map_GetMap is equivalent to calling [[zeolite:functions: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 [[zeolite:varID|variable types]] too.