Pyrogenesis  13997
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | Private Attributes | List of all members
CMapSummaryReader Class Reference

A restricted map reader that returns various summary information for use by scripts (particularly the GUI). More...

#include <MapReader.h>

Public Member Functions

PSRETURN LoadMap (const VfsPath &pathname)
 Try to load a map file. More...
 
CScriptValRooted GetMapSettings (ScriptInterface &scriptInterface)
 Returns a value of the form: More...
 

Private Attributes

CStr m_ScriptSettings
 

Detailed Description

A restricted map reader that returns various summary information for use by scripts (particularly the GUI).

Definition at line 159 of file MapReader.h.

Member Function Documentation

CScriptValRooted CMapSummaryReader::GetMapSettings ( ScriptInterface scriptInterface)

Returns a value of the form:

* {
* "settings": { ... contents of the map's <ScriptSettings> ... }
* }
*

Definition at line 373 of file MapReader.cpp.

PSRETURN CMapSummaryReader::LoadMap ( const VfsPath pathname)

Try to load a map file.

Parameters
pathnamePath to .pmp or .xml file

Definition at line 342 of file MapReader.cpp.

Member Data Documentation

CStr CMapSummaryReader::m_ScriptSettings
private

Definition at line 179 of file MapReader.h.


The documentation for this class was generated from the following files: